state_store 0.0.2 → 0.0.3

data/README.md

@@ -0,0 +1,81 @@
+# State store
+
+## Installation
+
+`gem install state_store`
+
+`require 'state_store'`
+
+For Bundler add this in you Gemfile
+
+`gem state_store, '~>0.0.2'`
+
+And then run
+
+`bundle install`
+
+## Usage
+
+State store all to keep different states in one attribute.
+It provide module for mixin, it is pure ruby so it is possible to use it in any ruby class.
+ 
+```ruby
+   class MyFile
+      include StateStore
+      attr_accessor :permission
+
+      has_states :read,:write,:execute, :in => :permission
+   end
+
+   file = MyFile.new
+   file.states = [:read,:write]
+   file.has_permission?(:read) #=> true
+   file.has_permission?(:execute) #=> false
+   file.permission #=> 5
+   file.states #=> [:read,:write]
+```
+
+It is possible to configure behaviour for #has_states
+
+* **:in** is method name where states are stored in numeric format
+* **:as** allow to change method for states (default is :states). This is useful if you have more than one state attribute per class.
+
+### Adding new states
+
+When you need to add new states and you keep want to previous states configurations be valid, then you should add new state as first in queue.
+
+```ruby 
+   class Wolf
+      include StateStore
+      has_states :big,:bad, :in => :characteristic, :as => :nature
+   end
+
+   wolf = Wold.new()
+   wolf.nature = [:bad]
+   wolf.characteristic #=> 1
+
+```
+
+Then if you decide to add _hungry_ then you change states as shown below and that will keep previous configuration valid as well as new one.
+
+```ruby
+   class Wolf
+      include StateStore
+      has_states :hungry, :big, :bad, :in => :characteristic, :as => :nature
+   end
+
+   wolf = Wolf.new()
+   wolf.nature = [:bad]
+   wolf.characteristic #=> 1
+   wolf.nature = [:hungry,:bad]
+   wolf.nature << :bad
+   wolf.has_charasteristic?(:bad) #=> true
+   wolf.characteristic #=> 5   
+```
+
+
+## Copyright
+
+Copyright (c) 2012 Arturs Meisters. See LICENSE.txt for
+further details.
+

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/state_store/extension.rb

@@ -4,19 +4,20 @@ module StateStore
     module ClassMethods
 
       def has_states *states
-        state_store_options = states && states.last.is_a?(Hash) && states.pop || {}
+        states_stores_options = states && states.last.is_a?(Hash) && states.pop || {}
         raise ArgumentError.new("No states given") if states.empty? 
-        raise ArgumentError.new(":in is required") unless state_store_options[:in]
+        raise ArgumentError.new(":in is required") unless states_stores_options[:in]
 
-        state_store_options[:as] ||= :states
+        states_stores_options[:as] ||= :states
         store = StateStore::BinaryStore.new(states)
 
         @states_stores ||={}
         @states_stores_options ||={}
+        validate_state_store(states_stores_options)
 
-        @states_stores[state_store_options[:as]] = store
-        @states_stores_options[state_store_options[:as]] = state_store_options
-        create_methods_for_state_store(state_store_options[:as])
+        @states_stores[states_stores_options[:as]] = store
+        @states_stores_options[states_stores_options[:as]] = states_stores_options
+        create_methods_for_state_store(states_stores_options[:as])
       end 
 
       def states_stores
@@ -29,6 +30,15 @@ module StateStore
 
       private
 
+      def validate_state_store(options)
+        raise ArgumentError.new("Scope '#{options[:as]}' already exists") if states_stores_options.keys.include?(options[:as])
+        states_stores_options.each do |scope,conf_options|
+          if conf_options[:in].to_sym == options[:in].to_sym
+            raise ArgumentError.new("Scope '#{scope}' already store configuration in '#{conf_options[:in]}'")
+          end
+        end
+      end
+
       def create_methods_for_state_store(name)
 
         self.class_eval do 
@@ -41,6 +51,7 @@ module StateStore
           define_method :"#{name}=" do |humanized_array|
             method_name = self.class.states_stores_options[name][:in]
             store = self.class.states_stores[name]
+            humanized_array = [humanized_array] unless humanized_array.is_a?(Array)
             self.send(:"#{method_name}=",store.value(humanized_array))
           end
         end

data/spec/extension_spec.rb

@@ -26,6 +26,27 @@ describe StateStore::Extension do
       }.to raise_error(ArgumentError,":in is required")
     end
 
+    it "should create scope in class for each state store by default with name :states" do 
+      klass.has_states :read,:write, :in => :status
+      klass.states_stores.keys.should eq([:states])
+      klass.has_states :green,:round, :in => :other_status, :as => :properties
+      klass.states_stores.keys.sort.should eq([:properties,:states])
+    end
+
+    it "should validate if there is scope with same name" do 
+      klass.has_states :read,:write, :in => :status
+      expect{
+        klass.has_states :green, :round, :in => :other_status
+      }.to raise_error(ArgumentError, "Scope 'states' already exists")
+    end   
+
+    it "should validate if there is scope with same storage attribute" do 
+      klass.has_states :read,:write, :in => :status
+      expect{
+        klass.has_states :green, :round, :in => :status, :as => :properties
+      }.to raise_error(ArgumentError, "Scope 'states' already store configuration in 'status'")
+    end
+
     it "should create store with given statuses" do 
       klass.has_states :read,:write, :in => :status
       klass.states_stores[:states].statuses.should eq([:read,:write])

data/state_store.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "state_store"
-  s.version = "0.0.1"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Arturs Meisters"]
@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.email = "arturs.meisters@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "lib/state_store.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_store
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &19920720 !ruby/object:Gem::Requirement
+  requirement: &17268180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *19920720
+  version_requirements: *17268180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &19919080 !ruby/object:Gem::Requirement
+  requirement: &17266720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *19919080
+  version_requirements: *17266720
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &19936760 !ruby/object:Gem::Requirement
+  requirement: &17284400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,21 +43,21 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *19936760
+  version_requirements: *17284400
 description: Create numeric value to Array of states.
 email: arturs.meisters@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .rspec
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/state_store.rb
@@ -83,7 +83,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2977312246934280863
+      hash: -4107345820124143679
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,19 +0,0 @@
-= state_store
-
-Description goes here.
-
-== Contributing to state_store
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2012 Arturs Meisters. See LICENSE.txt for
-further details.
-