simple_set 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 392d564ce8a892deb4861f90a081fc1464589c51
-  data.tar.gz: 7c6d23cf091f87f21c9b838dad2e0355c2002793
+  metadata.gz: 9ac5283b146313f3608674a583ccb44b71a94278
+  data.tar.gz: f823e20306eebae24a9fe94183afbf535b845b0f
 SHA512:
-  metadata.gz: 2ae3c96a417abc5d3347c6b39bb821586d9786c5376cae6846dcddcd8eb9e4709023e95b70e852ae2f60eb4428b513635abe3f2ce65c7f078ea5ca84ebcea86d
-  data.tar.gz: fb99df0dc0099801202081fe1b6fe31c9ad13087180f413a63a66b86229effc8bdb326049c6033fca570379e441928d5b89541997a7c6382a215e2e18f1ed893
+  metadata.gz: 2c7b61ab0020e2c6f688e3ac16370a3bdc71c192c7cf1116103cb2353a74ae1c43c9f1ffe396d8fc293d78c81576c157e2cc7a354844d75b1d71b92a83d41b63
+  data.tar.gz: 32a46d29080020a5e02d3724efb6a1d581d619802d4ca210cb6748655295695385bf9364849ca6babb2e242009407a4783f6cf8b390c742be733db899f0109c4

data/README.md

@@ -1,4 +1,4 @@
-# SimpleSet [![Build Status](https://travis-ci.org/smortex/simple_set.png?branch=master)](https://travis-ci.org/smortex/simple_set)
+# SimpleSet [![Build Status](https://travis-ci.org/sante-link/simple_set.png?branch=master)](https://travis-ci.org/sante-link/simple_set)
 
 A Rails plugin which brings easy-to-use set-like functionality to ActiveRecord models.
 
@@ -8,48 +8,62 @@ This is based on [SimpleEnum](https://github.com/lwe/simple_enum).
 
 Add this line to your application's Gemfile:
 
-    gem 'simple_set'
+```
+gem 'simple_set'
+```
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install simple_set
+```
+$ gem install simple_set
+```
 
 ## Usage
 
 Add this to a model:
 
-    class User < ActiveRecord::Base
-      as_set :roles, [:accounting, :management]
-    end
+```ruby
+class User < ActiveRecord::Base
+  as_set :roles, [:accounting, :management]
+end
+```
 
 Then create the required `roles_cd` column using migrations:
 
-    class AddRolesToUsers < ActiveRecord::Migration
-      def change
-        add_column :users, :roles_cd, :integer
-      end
-    end
+```ruby
+class AddRolesToUsers < ActiveRecord::Migration
+  def change
+    add_column :users, :roles_cd, :integer
+  end
+end
+```
 
 Now, it's possible to manage roles with maximum ease:
 
-    bob = User.new
-    bob.roles = [:accounting]
-    bob.accounting?           #=> true
-    bob.management?           #=> false
-    bob.roles                 #=> [:accounting]
-    bob.roles_cd              #=> 1
+```ruby
+bob = User.new
+bob.roles = [:accounting]
+bob.accounting?           #=> true
+bob.management?           #=> false
+bob.roles                 #=> [:accounting]
+bob.roles_cd              #=> 1
+```
 
 ## Gotchas
 
 1. Acceptable values can be provided as an `Array` or as a `Hash`, the
    following lines are equivalent:
 
-        as_set :spoken_languages, [:english, :french, :german, :japanese]
-        as_set :spoken_languages, {english: 1, french: 2, german: 4, japanese: 8}
+   ```ruby
+   as_set :spoken_languages, [:english, :french, :german, :japanese]
+   as_set :spoken_languages, {english: 1, french: 2, german: 4, japanese: 8}
+   ```
 
    Reordering the array will change each element's value which is likely
    unwanted.  Either only append new elements to the `Array` notation or use
@@ -58,29 +72,50 @@ Now, it's possible to manage roles with maximum ease:
 2. Although the `Hash` notation is less intuitive than the `Array` notation, it
    allows some neat tricks:
 
-        class User
-          as_set :roles, {
-            management: 1,
-            accounting: 2,
-            human_resources: 4,
+   ```ruby
+   class Pixel
+     as_set :rgb, {
+       red: 1,
+       green: 2,
+       blue: 4,
 
-            director: 7,
-          }
-        end
+       yellow: 3,
+       magenta: 5,
+       cyan: 6,
+       white: 7,
+     }
+   end
 
-        bob = User.create(roles: [:management, :accounting])
-        bob.director?                                         #=> false
-        bob.human_resources = true
-        bob.director?                                         #=> true
+   x = Pixel.create(rgb: [:red, :blue])
+   x.red?          #=> true
+   x.green?        #=> false
+   x.blue?         #=> true
+
+   x.yellow?       #=> false
+   x.magenta?      #=> true
+   x.cyan?         #=> false
+
+   x.white?        #=> false
+
+   x.green = true
+   x.white?        #=> true
+   ```
 
 3. If the shortcut methods (like `<symbol>?`, `<symbol>=` or `Klass.<symbol>`)
-   conflict with something in your class, it’s possible to define a prefix:
+   conflict with something in your class, an error will be raised.  You can
+   avoid this situation by defining a prefix:
 
-        class Lp < ActiveRecord::Base
-          as_set :media_conditions, [:new, :sealed, :very_good, :good, :fair, :poor], prefix: true
-        end
+   ```ruby
+   class Lp < ActiveRecord::Base
+     # Without :prefix, the :new media condition bellow would generate a
+     # Lp::new method that returns 1 and overrides the constructor.  This is
+     # likely unwanted and a :prefix must be set to avoid this situation:
+     as_set :media_conditions, [:new, :sealed, :very_good, :good, :fair, :poor], prefix: true
+   end
 
-        Bug.media_condition_new #=> 1
+   Lp.media_condition_new #=> 1
+   Lp.new                 #=> #<Lp:0x00000803c22b98>
+   ```
 
    When `:prefix` is set to `true`, shortcut methods are prefixed by the
    _singularized name_ of the attribute.
@@ -93,35 +128,43 @@ Now, it's possible to manage roles with maximum ease:
    methods (`<symbol>?`, `<symbol>=` and `Klass.<symbol>`), to do so just add
    the option `slim: true`:
 
-        class User
-          as_set :spoken_languages, [:english, :french, :german, :japanese], slim: true
-        end
+   ```ruby
+   class User
+     as_set :spoken_languages, [:english, :french, :german, :japanese], slim: true
+   end
 
-        bob = User.create(spoken_languages: [:english, :french]
-        bob.spoken_languages #=> [:english, :french]
-        bob.french?          #=> throws NoMethodError: undefined method `french?'
-        bob.french = false   #=> throws NoMethodError: undefined method `french='
-        User.french          #=> throws NoMethodError: undefined method `french'
+   bob = User.create(spoken_languages: [:english, :french]
+   bob.spoken_languages #=> [:english, :french]
+   bob.french?          #=> throws NoMethodError: undefined method `french?'
+   bob.french = false   #=> throws NoMethodError: undefined method `french='
+   User.french          #=> throws NoMethodError: undefined method `french'
+   ```
 
 5. Easy Rails integration:
 
    Given a `User` is declared as:
 
-        class User < ActiveRecord::Base
-          as_set :roles, [:management, :accounting, :human_resources]
-        end
+   ```ruby
+   class User < ActiveRecord::Base
+     as_set :roles, [:management, :accounting, :human_resources]
+   end
+   ```
 
    Adjust strong parameters to allow roles assignment:
 
-        params.require(:user).permit(:roles => [])
+   ```ruby
+   params.require(:user).permit(:roles => [])
+   ```
 
    And then render a collection of checkboxes:
 
-        = form_for @user do |f|
-          = f.collection_check_boxes(:roles, User.roles, :to_sym, :to_sym) do |b|
-            = b.check_box
-            = b.label do
-              = t("application.roles.#{b.text}")
+   ```haml
+   = form_for @user do |f|
+     = f.collection_check_boxes(:roles, User.roles, :to_sym, :to_sym) do |b|
+       = b.check_box
+       = b.label do
+         = t("application.roles.#{b.text}")
+   ```
 
 ## Contributing
 

data/lib/simple_set/set_hash.rb

@@ -1,7 +1,7 @@
 require 'simple_enum/enum_hash'
 
 module SimpleSet
-  class SetHash < ::SimpleEnum::EnumHash
+  class SetHash < ::ActiveSupport::OrderedHash
     def initialize(args = [], strings = false)
       super()
 
@@ -13,6 +13,14 @@ module SimpleSet
         ary ||= args
         ary.each { |e| set_value_for_reverse_lookup(e[0], strings ? e[0].to_s : e[1]) }
       end
+
+      freeze
+    end
+
+  private
+    def set_value_for_reverse_lookup(key, value)
+      sym = ::SimpleEnum::EnumHash.symbolize(key)
+      self[key] = value
     end
   end
 end

data/lib/simple_set/version.rb

@@ -1,3 +1,3 @@
 module SimpleSet
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/simple_set.rb

@@ -109,7 +109,7 @@ module SimpleSet
       if options[:slim] != true then
         prefix = options[:prefix] && "#{options[:prefix] == true ? set_cd.to_s.singularize : options[:prefix]}_"
         values.each do |k,code|
-          sym = SetHash.symbolize(k)
+          sym = ::SimpleEnum::EnumHash.symbolize(k)
 
           define_method("#{prefix}#{sym}?") do
             current = send(options[:column]) || 0

data/simple_set.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Romain Tartière"]
   spec.email         = ["romain@blogreen.org"]
   spec.summary       = %q{Simple set-like field support for ActiveModel}
-  spec.homepage      = "https://github.com/smortex/simple_set"
+  spec.homepage      = "https://github.com/sante-link/simple_set"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_set
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Romain Tartière
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-29 00:00:00.000000000 Z
+date: 2014-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_enum
@@ -115,7 +115,7 @@ files:
 - spec/simple_set_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
-homepage: https://github.com/smortex/simple_set
+homepage: https://github.com/sante-link/simple_set
 licenses:
 - MIT
 metadata: {}
@@ -143,4 +143,3 @@ test_files:
 - spec/simple_set_spec.rb
 - spec/spec_helper.rb
 - spec/support/models.rb
-has_rdoc: