Windows Mobile Support

  • Subscribe to our RSS feed.
  • Twitter
  • StumbleUpon
  • Reddit
  • Facebook
  • Digg

Wednesday, 29 August 2012

Java Script code refactoring - hands on code

Posted on 23:11 by Unknown
Let's see how we can create a mechanism that based on some flags; it will able to determine the status of some objects. The first version of code would look like this:
ItemStatus = {
Status1: "Status1",
Status2: "Status2",
Status3: "Status3"
}();

ItemTypes = {
Item1: "Item1",
Item2: "Item2",
Item3: "Item 3"
}();

var ItemConfiguration = function () {

function ItemConfiguration() {

}

ItemConfiguration.prototype = function () {
getItemConfiguration: function (itemTypes, flag1, flag2, flag3, flag4) {
switch (itemTypes) {
case ItemTypes.Item1:
if (flag1 && flag2) {
return ItemStatus.Status1;
} else if (flag3 || flag4) {
return ItemStatus.Status2;
}
break;
case ItemTypes.Item2:
if (flag3 || flag2) {
return ItemStatus.Status3;
} else if (flag1 || flag2) {
return ItemStatus.Status1;
}
break;
case ItemTypes.Item3:
if (flag3 || flag1 && flag3) {
return ItemStatus.Status1;
} else if (flag2 && flag4) {
return ItemStatus.Status3;
}
break;
}
}
};

return ItemConfiguration;
} ();

First problem is related to default values. If the flags combination from switch doesn’t return any value, that we should notify one way or another user about this issues. We end up throwing an expectation.
var ItemConfiguration = function () {

function ItemConfiguration() {

}

ItemConfiguration.prototype = function () {
getItemConfiguration: function (itemType, flag1, flag2, flag3, flag4) {
switch (itemType) {
case ItemTypes.Item1:
if (flag1 && flag2) {
return ItemStatus.Status1;
} else if (flag3 || flag4) {
return ItemStatus.Status2;
}
break;
case ItemTypes.Item2:
if (flag3 || flag2) {
return ItemStatus.Status3;
} else if (flag1 || flag2) {
return ItemStatus.Status1;
}
break;
case ItemTypes.Item3:
if (flag3 || flag1 && flag3) {
return ItemStatus.Status1;
} else if (flag2 && flag4) {
return ItemStatus.Status3;
}
break;
}

throw {
message: "No flags matching for " + itemType + "with the flags combination"
+ "flag1: " + flag1 + ", "
+ "flag2: " + flag2 + ", "
+ "flag3: " + flag3 + ", "
+ "flag4: " + flag4 + ", "
};
}
};

return ItemConfiguration;
} ();
Almost okay we think. When we look over the requirements we notify that the user will need the status for all items. Because of this he will need to make 3 different calls. For each call he would need to add all the parameters over and over again. We can have two possible solutions. One is to create an object that has all this flags. The other option is to change our method to return the status for all our item types. I would go with the second approach.
var ItemConfiguration = function () {

function ItemConfiguration() {

}

ItemConfiguration.prototype = function () {
getItemsConfiguration: function(flag1, flag2, flag3, flag4) {
var itemsStatus = new Object();
itemsStatus[ItemTypes.Item1] = _getStatusForItem1(flag1, flag2, flag3, flag4);
itemsStatus[ItemTypes.Item2] = _getStatusForItem2(flag1, flag2, flag3, flag4);
itemsStatus[ItemTypes.Item3] = _getStatusForItem3(flag1, flag2, flag3, flag4);

return itemsStatus;
},

_getStatusForItem1:function(flag1, flag2, flag3, flag4) {
if (flag1 && flag2) {
return ItemStatus.Status1;
} else if (flag3 || flag4) {
return ItemStatus.Status2;
}

_noStatusHandler();
},

_getStatusForItem2:function(flag1, flag2, flag3, flag4) {
if (flag3 || flag2) {
return ItemStatus.Status3;
} else if (flag1 || flag2) {
return ItemStatus.Status1;
}

_noStatusHandler();
},

_getStatusForItem3:function(flag1, flag2, flag3, flag4) {
if (flag3 || flag1 && flag3) {
return ItemStatus.Status1;
} else if (flag2 && flag4) {
return ItemStatus.Status3;
}

_noStatusHandler();
},

_noStatusHandler:function() {
throw {
message: "No flags matching for " + itemType + "with the flags combination"
+ "flag1: " + flag1 + ", "
+ "flag2: " + flag2 + ", "
+ "flag3: " + flag3 + ", "
+ "flag4: " + flag4 + ", "
};
}
};

return ItemConfiguration;
} ();
For each item type we extracted a method that calculates the item status. In the case for the input flags we cannot retrieve a status we throw an exception. In our public method, we create an object that contains our item types and status. In this way we removed the switch and the code looks better.
The thing that has a smell is the 4 parameters that are send each time in our private method. We could create an internal object with these 4 parameters and send it as parameter for each private method. Another option is to create 4 private fields and each private method can use them. Because we don’t have any problem with thread concurrency in JavaScript we can go with the second approach without any problem.
var ItemConfiguration = function () {

var flag1, flag2, flag3, flag4;

function ItemConfiguration() {

}

ItemConfiguration.prototype = function () {
getItemsConfiguration: function(flag1, flag2, flag3, flag4) {
this.flag1 = flag1;
this.flag2 = flag2;
this.flag3 = flag3;
this.flag4 = flag4;

var itemsStatus = new Object();
itemsStatus[ItemTypes.Item1] = _getStatusForItem1();
itemsStatus[ItemTypes.Item2] = _getStatusForItem2();
itemsStatus[ItemTypes.Item3] = _getStatusForItem3();

return itemsStatus;
},

_getStatusForItem1:function() {
if (this.flag1 && this.flag2) {
return ItemStatus.Status1;
} else if (this.flag3 || this.flag4) {
return ItemStatus.Status2;
}

_noStatusHandler();
},

_getStatusForItem2:function() {
if (this.flag3 || this.flag2) {
return ItemStatus.Status3;
} else if (this.flag1 || this.flag2) {
return ItemStatus.Status1;
}

_noStatusHandler();
},

_getStatusForItem3:function() {
if (this.flag3 || this.flag1 && this.flag3) {
return ItemStatus.Status1;
} else if (this.flag2 && this.flag4) {
return ItemStatus.Status3;
}

_noStatusHandler();
},

_noStatusHandler:function() {
throw {
message: "No flags matching for " + itemType + "with the flags combination"
+ "flag1: " + flag1 + ", "
+ "flag2: " + flag2 + ", "
+ "flag3: " + flag3 + ", "
+ "flag4: " + flag4 + ", "
};
}
};

return ItemConfiguration;
} ();
It seems that the code looks cleaner in this way and is easier to read. For the private method, I would let the user to specify all the parameters because is more clear for him and he don’t need to create a new object to send the parameters and use it only in one place.
One thing that came to my mind is to create an object or a dictionary that contains the private functions for each item type. But it would be to complex and I don’t know if is worth it.
What do you think? Do you see another way to implement it?



Last edit: Another option is to create a mapping based on the flags (for example each combinations of flag has a unique key that point to an object that has our item types configuration –ex: flag1*2^0+flag2*2^1+flag3*2^3 in base 10 or we could use a mapping in base 2). What is my concern for this solution is the complexity of the code increase, even if the numbers of line are less and we don’t have the IF statements anymore.
 
Email ThisBlogThis!Share to XShare to FacebookShare to Pinterest
Posted in clean code, java script | No comments
Newer Post Older Post Home

0 comments:

Post a Comment

Subscribe to: Post Comments (Atom)

Popular Posts

  • Service Bus Topic - Automatic forward messages from a subscription to a topic
    Windows Azure Service Bus Topic is a service that enables us to distribute the same messages to different consumers without having to know e...
  • Patterns in Windows Azure Service Bus - Message Splitter Pattern
    In one of my post about Service Bus Topics from Windows Azure I told you that I will write about a post that describe how we can design an a...
  • CDN is not the only solution to improve the page speed - Reverse Caching Proxy
    I heard more and more often think like this: “If your website is to slow, you should use a CDN.” Great, CDN is THE solution for any kind of ...
  • E-Learning Vendors Attempt to Morph Mobile
    The sign should read: " Don't touch! Wet Paint !" I had a good chuckle today after receiving my latest emailed copy of the eLe...
  • Content Types - Level 6: Rich Media
    Level 6: Rich Media NOTE: This is part 7 of 7 and the conclusion of this continuing series; please see earlier posts for more background inf...
  • Publishing our CellCast Widget for iPad
    The rush has been on this week as our development team worked to design a new version of our CellCast Widget specifically for Apple's up...
  • Content Types - Level 5: Courseware
    Level 5: Content and Courseware NOTE: This is part 6 of 7 in a continuing series; please see earlier posts for more background information. ...
  • SQL - UNION and UNION ALL
    I think that all of us used until now UNION in a SQLstatement. Using this operator we can combine the result of 2 queries. For example we wa...
  • Cum sa salvezi un stream direct intr-un fisier
    Cred ca este a 2-a oara când întâlnesc aceasta cerința in decurs de câteva săptămâni. Se da un stream și o locație unde trebuie salvat, se c...
  • Content Types - Level 4: Reference
    Level 4: Reference Materials & Static Content NOTE: This is part 5 of 7 in a continuing series; please see earlier posts for more backgr...

Categories

  • .NET
  • .NET nice to have
  • #if DEBUG
  • 15 iunie 2011
  • 15 octombrie 2011
  • 2011
  • abstracta
  • action
  • adaugare
  • ajax
  • Amsterdam
  • Android
  • aplicatii
  • App Fabric
  • Apple iSlate
  • array
  • as
  • ASP.NET
  • AsReadOnly
  • Assembly comun
  • async
  • Asynchronous programming
  • asyncron
  • Autofac
  • AutoMapper
  • az
  • Azure
  • Azure AppFabric Cache
  • Azure backup solution
  • Azure Storage Explorer
  • azure. cloud
  • backup
  • BCP utility
  • bing maps v7
  • BitArray
  • BlackBerry
  • blob
  • BlobContainerPublicAccessType
  • breakpoint
  • bucuresti
  • C#
  • cache
  • CallerMemberName
  • CellCast
  • Certificate
  • CES
  • change
  • ChannelFactory
  • clasa
  • classinitialize
  • clean code
  • click event
  • close
  • Cloud
  • Cluj
  • cluj-napoca
  • Code contracts
  • code retrat
  • codecamp
  • CollectionAssert
  • Compact Edition
  • compara
  • Comparer T .Default
  • CompareTo
  • comparison
  • comunitate
  • concurs
  • Conditional attribute
  • configurare
  • connection string
  • container
  • content type
  • control
  • Convert
  • convertAll
  • convertor
  • cross platform
  • CRUD
  • css
  • custom properties
  • custom request
  • DACPAC
  • Daniel Andres
  • data sync service
  • database
  • date time
  • datetime
  • debug
  • default
  • delegate
  • dependency injection
  • deploy
  • DeploymentItem
  • design patterns
  • Dev de Amsterdam
  • development stoage
  • dictionary
  • diferente
  • digging
  • director
  • Directory.Exist
  • disable
  • dispatcher
  • dispose
  • dropdown
  • dynamic
  • EF
  • email
  • encoding
  • entity framework
  • enum
  • enumerable
  • Environment.NewLine
  • error
  • error 404
  • error handling
  • eveniment
  • event
  • ews
  • excel
  • exception
  • exchange
  • exita
  • explicit
  • export
  • extension
  • field
  • File.Exist
  • finalize
  • fire and forget
  • Fluent interface pattern
  • format
  • func
  • GC.SuppressFinalize
  • generic
  • getdirectoryname
  • globalization
  • gmail
  • hackathon
  • Hadoop
  • handle
  • HTML
  • html 5
  • Html.ActionLink
  • http://www.blogger.com/img/blank.gif
  • HttpModule
  • IComparable
  • IE
  • ienumerable
  • IIS
  • image
  • implicit
  • import
  • int
  • internationalization
  • Internet Explorer
  • interop
  • Ioc
  • IP Filter
  • iPhone
  • iQuest
  • IStructuralEquatable
  • ITCamp
  • itspark
  • java script
  • javascript
  • July 2012
  • KeyedByTypeCollection
  • KeyNotFoundException
  • Kinect SDK
  • lambda expression
  • LightSwitch Microsoft Silverlight
  • linq
  • list
  • lista
  • lista servicii
  • liste
  • Live Connect
  • Live ID
  • load
  • localization
  • lock
  • m-learning
  • MAC
  • Mango
  • map
  • mapare
  • mapare propietati
  • messagequeue
  • meta properties
  • method
  • MethodImpl
  • Metro App
  • Microsoft
  • Microsoft Sync Framework
  • mlearning
  • mlearning devices
  • Mobile Apps
  • mobile in the cloud
  • mobile learning
  • mobile services
  • Mobile Web
  • mongoDb
  • monitorizare
  • msmq
  • multitasking
  • MVC
  • MVC 3
  • MVVM
  • namespace
  • nextpartitionkey
  • nextrowkey
  • Ninject
  • nivel acces
  • no result
  • normalize
  • nosql
  • null expcetion
  • null object pattern
  • NullReferenceException
  • OAuth API
  • office
  • offline
  • Open ID
  • openhackeu2011
  • operations
  • operator
  • optimization
  • option
  • outputcache
  • OutputCacheProvider
  • override
  • paginare
  • pagination
  • path
  • persistare
  • Portable Library tool
  • Post event – CodeCamp Cluj-Napoca
  • predicate
  • predictions
  • prezentare
  • process
  • proiect
  • property
  • propietati
  • query
  • ReadOnlyCollection
  • ReadOnlyDictionary
  • referinta
  • reflection
  • remote
  • reply command
  • request
  • request response
  • resouce
  • REST
  • REST Client
  • RESTSharp
  • ronua
  • rss
  • rulare
  • salvare in fisier
  • sc
  • schimbare timp
  • select
  • select nodes
  • send
  • serializare
  • serialization
  • Server.Transfer. Resposen.Redirect
  • service bus
  • ServiceBase
  • servicecontroller
  • sesiune
  • session
  • Session_End
  • Session_Start
  • setup
  • Sibiu
  • signalR
  • Silverlight
  • sincronizare
  • Single Responsibility Principle
  • SkyDrive
  • skype
  • smartphones
  • smtp
  • Snapguide
  • sniffer
  • socket
  • solid
  • spec#
  • sql
  • Sql Azure
  • SQL CE
  • sql server 2008 RC
  • SRP
  • startuptype
  • stateful
  • stateless
  • static
  • stergere
  • store
  • store procedure
  • stream
  • string
  • string.join
  • struct
  • StructuralEqualityComparer
  • submit
  • switch
  • Symbian
  • Synchronized
  • system
  • tabele
  • table
  • techEd 2012
  • tempdata
  • test
  • testcleanup
  • testinitialize
  • testmethod
  • thread
  • timer
  • ToLower
  • tool
  • tostring
  • Total Cost Calculator
  • trace ASP.NET
  • transcoding
  • tuplu
  • tutorial
  • TWmLearning
  • type
  • unit test
  • unittest
  • UrlParameter.Optional
  • Validate
  • validation
  • verificare
  • video
  • view
  • ViewBag
  • virtual
  • visual studio
  • VM role
  • Vunvulea Radu
  • wallpaper
  • WCF
  • WebBrower
  • WebRequest
  • where clause
  • Windows
  • windows 8
  • Windows Azure
  • Windows Azure Service Management CmdLets
  • windows live messenger
  • Windows Mobile
  • Windows Phone
  • windows service
  • windows store application
  • Windows Task
  • WinRT
  • word
  • workaround
  • XBox
  • xml
  • xmlns
  • XNA
  • xpath
  • YMesseger
  • Yonder
  • Zip

Blog Archive

  • ►  2013 (139)
    • ►  November (17)
    • ►  October (12)
    • ►  September (10)
    • ►  August (7)
    • ►  July (8)
    • ►  June (15)
    • ►  May (12)
    • ►  April (17)
    • ►  March (16)
    • ►  February (9)
    • ►  January (16)
  • ▼  2012 (251)
    • ►  December (9)
    • ►  November (19)
    • ►  October (26)
    • ►  September (13)
    • ▼  August (35)
      • Service Bus Topic – How we can migrate from Servic...
      • Service Bus Topic - Different ways to create and m...
      • Service Bus Topics - Using with WCF services
      • Java Script code refactoring - hands on code
      • C# error at compile time challenge
      • Service Bus Topics - Limitations
      • Service Bus Topics - How to use it (part 2)
      • Service Bus Topics - How to use it (part 1)
      • Service Bus Topics - Overview
      • Where we can add resjson files in a Metro Application
      • Service Bus Queues blog post series – a comprehens...
      • Service Bus Queues from Windows Azure - Business ...
      • Service Bus Queues from Windows Azure - Integratio...
      • Service Bus Queues from Windows Azure - Scheduling
      • Promises and Asynchron calls in Metro Application ...
      • Service Bus Queues from Windows Azure - BrokeredMe...
      • Service Bus Queues from Windows Azure - How to ret...
      • Service Bus Queues from Windows Azure - Death lett...
      • Service Bus Queues vs Windows Azure Queues
      • Don't name your class "XXXManager"
      • Metro Apps on Window 8 - What to use? XAML/HTML? J...
      • Service Bus Queues from Windows Azure - How to sep...
      • Windows 8 Metro App - How to debug JS that was loa...
      • How to use Diagnostic Monitor on Windows Azure
      • Solution - A challenge with Promises from Java Script
      • Service Bus Queues from Windows Azure - How to ite...
      • A challenge with Promises from Java Script
      • Today Software Magazine – I had the honor to write...
      • How should we use Command/Query Segreration (part 2)
      • Service Bus Queues from Windows Azure - How to use it
      • How to define promises on Metro App for Windows 8 ...
      • How should we use Command/Query Segreration (part 1)
      • Service Bus Queues from Windows Azure - Introduction
      • Service Bus - Introduction to Service Bus of Windo...
      • Metro App - Call a Java Script method by name and ...
    • ►  July (28)
    • ►  June (27)
    • ►  May (24)
    • ►  April (18)
    • ►  March (17)
    • ►  February (20)
    • ►  January (15)
  • ►  2011 (127)
    • ►  December (11)
    • ►  November (20)
    • ►  October (8)
    • ►  September (8)
    • ►  August (8)
    • ►  July (10)
    • ►  June (5)
    • ►  May (8)
    • ►  April (9)
    • ►  March (14)
    • ►  February (20)
    • ►  January (6)
  • ►  2010 (26)
    • ►  December (1)
    • ►  November (1)
    • ►  October (1)
    • ►  June (2)
    • ►  May (1)
    • ►  April (4)
    • ►  March (1)
    • ►  February (1)
    • ►  January (14)
Powered by Blogger.

About Me

Unknown
View my complete profile