yinum 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c53d2bc9cc46a16d364551c488ad35a119fb3c4d
-  data.tar.gz: 2ac8672e7d86efb82b2ca054c4ed4108b7359d51
+  metadata.gz: a6c73933a509d17c611e833780d494509c743d76
+  data.tar.gz: 08cbfb277952c6542c39b1dc5ebe9e9e331f2682
 SHA512:
-  metadata.gz: 141e86d9162afd39eb923f927084325a4296f321c034572f410d2520c61779b57c97b2b063f28677a3fd779320c3e855be863073059f948a19e54980bef0b111
-  data.tar.gz: 2dc92e06508922e477382b08c844d102c621a4e2b1ddd6f862783398e553f936b85de1ac31fda44def0d41538ff274f6cd7743324528ca5887c6d92da96193ad
+  metadata.gz: 6e2e98a5b4b03df21652b9539da8e29e7a7661fde7df110d155172ef4c05bad87a3e8de61ae042490487139bee7b6a2e46252ddd1739d3cf51ec6a54a568dff1
+  data.tar.gz: 467a1640a733bdef9a958c1c8b452cfbe50af55cd913395af3bccceade2b6111ab3eab2224d56cd141eebb6ca389ead9d05b3be52d601082c6e28e1e1ed21766

data/.gitignore

@@ -15,3 +15,4 @@ capybara-*.html
 **.orig
 rerun.txt
 pickle-email-*.html
+tags

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+* `attr_enum` reader always returns an EnumValue.
+* `EnumValue#t` uses `String#titlelize` if it's available and I18n or the
+  specific translation are not available.

data/README.md

@@ -49,6 +49,12 @@ Getting enum values:
     => FRUITS.apple
     FRUITS[1]
     => FRUITS.apple
+    FRUITS['orange']
+    => FRUITS.orange
+    FRUITS['2']
+    => FRUITS.orange
+    FRUITS['orange', '1']
+    => [FRUITS.orange, FRUITS.apple]
 
 Comparing enum values:
 
@@ -72,6 +78,33 @@ The enum value is actually a delegate to the value with a special inspect and co
     fruit > FRUITS.apple
     => true
 
+Generating enum attribute methods for your class:
+
+    class Car
+      attr_accessor :color
+      attr_enum :color, :COLORS, :red => 1, :black => 2
+    end
+    car = Car.new
+    car.color = :red
+    car.color
+    => Car::COLORS.red
+    car.color = "2"
+    car.color
+    => Car::COLORS.black
+    car.color.black?
+    => false
+
+If this is a defining attribute for the class, add `:qualifier => true` to generate question methods like so:
+
+    class Car
+      attr_accessor :color
+      attr_enum :color, :COLORS, { :qualifier => true }, :red => 1, :black => 2
+    end
+    car = Car.new
+    car.color = :red
+    car.red?
+    => true
+
 How the enum gets along with Rails, assuming the following model:
 
     # == Schema Info
@@ -93,7 +126,7 @@ Now the `color` column is always read and written using the enum value feature:
     Car.last.color.red?
     => true
 
-This also creates a `validates\_inclusion\_of` with `allow\_nil => true` to prevent having bad values.
+This also creates a `validates_inclusion_of` with `allow_nil => true` to prevent having bad values.
 
 Adding a `:scoped => true` option before the enum values allows automatic generation of scopes and question
 methods on the model as follows:
@@ -106,7 +139,7 @@ methods on the model as follows:
     Car.last.red?
     => true
 
-You can also use another class's enum for your class with enum\_column (including generated methods) like so:
+You can also use another class's enum for your class with enum\_column and attr\_enum (including generated methods) like so:
 
     class Motorcycle < ActiveRecord::Base
       enum_column :color, Car::COLORS, { :scoped => true }
@@ -137,10 +170,12 @@ The following will occur:
     => "Green Apple"
     FRUITS[2].t
     => "Orange Color"
-    Car::COLORS.red
+    Car::COLORS.red.t
     => "Shiny Red"
-    Car::COLORS.black
+    Car::COLORS.black.t
     => "Actually, white"
+    Car::COLORS.options # nice for options_for_select
+    => { "Shiny Red" => :red, "Actually, white" => :black }
 
 When the enum is given a parent, the class's name is used in the translation.
 If the translation is missing, it fallbacks to the translation without the class's name.
@@ -152,13 +187,13 @@ All enum names (usually CONSTANT\_LIKE) and parent class names are converted to
 Since the `===` operator is called on the when value, this syntax cannot be used:
 
     case fruit
-      when :red then "This will never happen!"
+      when :apple then "This will never happen!"
     end
 
 The following should be used instead:
 
     case fruit
-      when FRUITS.red then "This is better..."
+      when FRUITS.apple then "This is better..."
     end
 
 This is because I had trouble overriding the `===` operator of the Symbol class.
@@ -169,3 +204,12 @@ Another limitation is the following:
     Car.where(:color => Car::COLORS.red) # good
 
 You may use the EnumValue object for anything, but don't get smart using the key.
+If the EnumValue doesn't work in a spot, use #name (in `options_for_select`) or #value (in `update_all`).
+
+## Also
+
+EnumValue also works well with [nil_or](https://github.com/toplex/nil_or):
+
+    fruit = FRUITS.apple
+    fruit.nil_or.t
+    => "Green Apple"

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/enum/enum_value.rb

@@ -1,7 +1,7 @@
 class Enum::EnumValue < BasicObject
   attr_reader :enum, :name, :value
 
-  def initialize(enum, name, value)
+  def initialize(enum, name = nil, value)
     @enum, @name, @value = enum, name, value
   end
 
@@ -10,36 +10,67 @@ class Enum::EnumValue < BasicObject
   end
 
   def inspect
+    return @value.inspect if @name.nil?
+
     "#{@enum.to_s}.#{@name}"
   end
 
   def ==(other)
+    return @value == other if @name.nil?
+
     @name == other or @value == other
   end
 
   def ===(other)
+    return @value === other if @name.nil?
+
     @name === other or @value === other
   end
 
-  def t(options={})
+  def t(options = {})
+    return @value.t(options) if @name.nil?
+    if not defined?(::I18n)
+      if @name.to_s.respond_to?(:titleize)
+        return @name.to_s.titleize
+      else
+        raise NotImplementedError, "I18n and String#titleize are not available"
+      end
+    end
+
     scope_without_klass = "enums.#{const_to_translation(@enum.name)}"
     if @enum.klass
       scope_with_klass = "enums.#{const_to_translation(@enum.klass.name)}.#{const_to_translation(@enum.name)}"
-      return "I18n not available: #{scope_with_klass}.#{@name}" unless defined?(::I18n)
 
-      ::I18n.t(@name,
-               # prefer scope with klass
-               options.reverse_merge(:scope => scope_with_klass,
-                                     :default => ::I18n.t(@name,
-                                                          # but if not, use without
-                                                          options.reverse_merge(:scope => scope_without_klass,
-                                                                                # but! if not, return scope with klass error
-                                                                                :default => ::I18n.t(@name,
-                                                                                                     options.reverse_merge(:scope => scope_with_klass))))))
+      ::I18n.t(
+        @name,
+        # prefer scope with klass
+        options.reverse_merge(
+          scope: scope_with_klass
+        ).merge( # our :default is a priority here
+          default: ::I18n.t(
+            @name,
+            # but if not, use without
+            options.reverse_merge(
+              scope: scope_without_klass,
+              # but! if not, return titleize or scope with klass error
+              default: @name.to_s.respond_to?(:titleize) ? @name.to_s.titleize : ::I18n.t(
+                @name,
+                options.reverse_merge(
+                  scope: scope_with_klass
+                )
+              )
+            )
+          )
+        )
+      )
     else
-      return "I18n not available: #{scope_without_klass}.#{@name}" unless defined?(::I18n)
-
-      ::I18n.t(@name, options.reverse_merge(:scope => scope_without_klass))
+      ::I18n.t(
+        @name,
+        options.reverse_merge(
+          scope: scope_without_klass,
+          default: (@name.to_s.titleize if @name.to_s.respond_to?(:titleize))
+        )
+      )
     end
   end
 

data/lib/enum/helpers/enum_attribute.rb

@@ -19,7 +19,7 @@ module Enum::Helpers::EnumAttribute
       e = const_get(name_or_enum)
     end
     # attribute reader
-    define_method(attr) { v = super(); (v.nil? or not e.values.include?(v)) ? v : e[v] }
+    define_method(attr) { v = super(); (v.nil? or not e.values.include?(v)) ? Enum::EnumValue.new(e, v) : e[v] }
     # attribute writer
     define_method("#{attr}=") { |v| v.nil? ? super(v) : super(e[v]) }
 

data/lib/enum/helpers/enum_column.rb

@@ -26,7 +26,7 @@ module Enum::Helpers::EnumColumn
   end
 end
 
-if defined?(ActiveRecord)
+if defined?(ActiveRecord::Base)
   class ActiveRecord::Base
     extend Enum::Helpers::EnumColumn
   end

data/lib/enum/version.rb

@@ -0,0 +1,3 @@
+class Enum
+  VERSION = '1.7.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yinum
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Oded Niv
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-18 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -33,16 +33,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
+- UNLICENSE
 - lib/enum.rb
 - lib/enum/enum_value.rb
 - lib/enum/helpers.rb
 - lib/enum/helpers/enum_attribute.rb
 - lib/enum/helpers/enum_column.rb
 - lib/enum/helpers/enum_generator.rb
+- lib/enum/version.rb
 - lib/yinum.rb
 - spec/lib/enum/enum_value_spec.rb
 - spec/lib/enum/helpers/enum_attribute_spec.rb
@@ -75,10 +78,4 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Enum implementation
-test_files:
-- spec/lib/enum/enum_value_spec.rb
-- spec/lib/enum/helpers/enum_attribute_spec.rb
-- spec/lib/enum/helpers/enum_column_spec.rb
-- spec/lib/enum/helpers/enum_generator_spec.rb
-- spec/lib/enum_spec.rb
-- spec/spec_helper.rb
+test_files: []