state_store 0.0.4 → 0.1.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head

data/Gemfile

@@ -7,11 +7,11 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.0.0"
+  gem "bundler", "~> 1.1.3"
   gem "jeweler", "~> 1.8.3"
 end
 
 group :test do 
-  gem "rspec", "~>2.9.0"
+  gem "rspec", "~>2"
 end
 

data/Gemfile.lock

@@ -25,7 +25,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
+  bundler (~> 1.1.3)
   jeweler (~> 1.8.3)
   rdoc (~> 3.12)
-  rspec (~> 2.9.0)
+  rspec (~> 2)

data/README.md

@@ -1,4 +1,7 @@
 # State store
+[![Build Status](https://secure.travis-ci.org/kalifs/state_store.png?branch=master)](http://travis-ci.org/kalifs/state_store)
+[![Gemnasium status](https://gemnasium.com/kalifs/state_store.png)](https://gemnasium.com/kalifs/state_store)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/kalifs/state_store)
 
 ## Installation
 
@@ -8,7 +11,7 @@
 
 For Bundler add this in you Gemfile
 
-`gem state_store, '~>0.0.2'`
+`gem state_store, '~>0.0.4'`
 
 And then run
 
@@ -50,7 +53,7 @@ When you need to add new states and you keep want to previous states configurati
       has_states :big,:bad, :in => :characteristic, :as => :nature
    end
 
-   wolf = Wold.new()
+   wolf = Wolf.new()
    wolf.nature = [:bad]
    wolf.characteristic #=> 1
 
@@ -68,7 +71,6 @@ Then if you decide to add _hungry_ then you change states as shown below and tha
    wolf.nature = [:bad]
    wolf.characteristic #=> 1
    wolf.nature = [:hungry,:bad]
-   wolf.nature << :bad
    wolf.has_charasteristic?(:bad) #=> true
    wolf.characteristic #=> 5   
 ```
@@ -93,7 +95,7 @@ It is possible to alter states Array and changes storage attribute will be updat
    apple.status #=> 5
 ```
 
-But remember if you will modify `states` with other methods, like '<<' or 'delete' or others changes will not be stored in status. 
+But remember if you will modify `states` with other methods, like `<<` or `delete` or others changes will not be stored in status. 
 
 
 ## Copyright

data/Rakefile

@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "state_store"
   gem.homepage = "http://github.com/kalifs/state_store"
   gem.license = "MIT"
-  gem.summary = %Q{Convert numeric value to Array of states}
-  gem.description = %Q{Create numeric value to Array of states.}
+  gem.summary = %Q{Store Array of states in single Integer.}
+  gem.description = %Q{It allows to store pre-defined set of states in one attribute as Integer}
   gem.email = "arturs.meisters@gmail.com"
   gem.authors = ["Arturs Meisters"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/lib/state_store/binary_store.rb

@@ -1,6 +1,8 @@
 require 'observer'
 
 module StateStore
+  # This class provides convertation between Array to binary number and vice versa.
+  # Each instance of class have its own set of statuses. 
   class BinaryStore
     attr_reader :statuses, :states, :total_positions
 
@@ -11,6 +13,7 @@ module StateStore
       @total_positions = 2**@states-1
     end
 
+    # Method receives value and return Array of statuses that matches current number.
     def humanize(value)
       raise ArgumentError.new("Out of range") if self.total_positions < value
       humanized_array = value_to_statuses(value)
@@ -18,24 +21,31 @@ module StateStore
       humanized_array
     end
 
+    # Method receives Array of statuses and create binary number that respresents this status for store statuses set.
+    # =====Example
+    #      store = StateStore.new([:read,:write,:execute])
+    #      store.value([:read,:execute]) # will be interpreted as 101 or 5
+    #      store.value([:write,:execute]) # will be interpreted as 011 or 3
     def value(humanized_array) 
       raise ArgumentError.new("Out of range") if self.states < humanized_array.size
       statuses_to_values(humanized_array)
     end
  
+    # It receives status and value and check if given value match given status.
+    # =====Example
+    #      store = StateStore.new([:read,:write,:execute])
+    #      store.has_status?(:read,4) # will be false because 4 is for :write only
+    #      store.has_status?(:read,5) # will be true because 5 is for :read and :execute
     def has_status?(symbol,value) 
       human_array = humanize(value)
       human_array.include?(symbol)
     end
 
+    # This method receives index and state and will retrun status with given index if state is "1"
     def index(index,state)
       statuses[index] if state.to_s == "1"
     end
 
-    def index_by_state(state)
-      statuses[state]
-    end
-
     private
 
     def value_to_statuses(value)

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+require 'cover_me'
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # Require this file using `require "spec_helper.rb"` to ensure that it is only

data/state_store.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "state_store"
-  s.version = "0.0.4"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Arturs Meisters"]
-  s.date = "2012-03-29"
-  s.description = "Create numeric value to Array of states."
+  s.date = "2012-08-30"
+  s.description = "It allows to store pre-defined set of states in one attribute as Integer"
   s.email = "arturs.meisters@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
@@ -37,24 +38,24 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/kalifs/state_store"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
-  s.summary = "Convert numeric value to Array of states"
+  s.rubygems_version = "1.8.24"
+  s.summary = "Store Array of states in single Integer."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.1.3"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
     else
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.1.3"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     end
   else
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.1.3"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_store
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-29 00:00:00.000000000 Z
+date: 2012-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &11849260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,21 +21,31 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *11849260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &11847580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *11847580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &11865240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,8 +53,13 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *11865240
-description: Create numeric value to Array of states.
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+description: It allows to store pre-defined set of states in one attribute as Integer
 email: arturs.meisters@gmail.com
 executables: []
 extensions: []
@@ -54,6 +69,7 @@ extra_rdoc_files:
 files:
 - .document
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -83,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -101757466199403532
+      hash: -2532584141716833600
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -92,8 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Convert numeric value to Array of states
+summary: Store Array of states in single Integer.
 test_files: []