yinum 1.0.0 → 1.1.0

data/README.md

@@ -163,3 +163,9 @@ The following should be used instead:
 
 This is because I had trouble overriding the `===` operator of the Symbol class.
 
+Another limitation is the following:
+
+    Car.where(:color => :red) # bad
+    Car.where(:color => Car::COLORS.red) # good
+
+You may use the EnumValue object for anything, but don't get smart using the key.

data/lib/enum/helpers/{enum_columns.rb → enum_attribute.rb}

@@ -1,41 +1,39 @@
 require 'enum/helpers/enum_generator'
 
-module Enum::Helpers::EnumColumns
-  # Bind a column to an enum by:
+module Enum::Helpers::EnumAttribute
+  include Enum::Helpers::EnumGenerator
+
+  # Bind an attribute to an enum by:
   #   Generating attribute reader and writer to convert to EnumValue.
-  #   Creating a validation for the attribute so it must have valid enum values (allowing nil).
-  #   If :scoped => true, generates scopes and questioning methods for every name in the enum.
+  #   If :qualifier => true, generates questioning methods for every name in the enum.
   # If given a enum name (a symbol) and hash, also creates the enum.
-  def enum_column(attr, name_or_enum, options={}, hash=nil)
+  def attr_enum(attr, name_or_enum, options = {}, hash = nil)
+    # the first hash is either options or the hash if the options are missing
+    hash, options = options, {} unless name_or_enum.is_a?(Enum) or hash
     # generating or getting the enum
     if name_or_enum.is_a?(Enum)
       e = name_or_enum
     else
-      # the first hash is either options or the hash if the options are missing
-      hash, options = options, {} if hash.nil?
       # generating the enum if the hash is not empty
       enum name_or_enum, hash if hash.any?
-
       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] }
     # attribute writer
     define_method("#{attr}=") { |v| v.nil? ? super(v) : super(e[v]) }
-    # validation
-    validates_inclusion_of attr, :in => e.values, :allow_nil => true
-    if options[:scoped]
+
+    if options[:qualifier]
       # generating scopes and questioning methods
       e.by_name.each do |n, ev|
-        scope n, where(attr => ev)
         define_method("#{n}?") { self[attr] == ev }
       end
     end
+
+    e
   end
 end
 
-if defined?(ActiveRecord)
-  class ActiveRecord::Base
-    extend Enum::Helpers::EnumColumns
-  end
+class Object
+  extend Enum::Helpers::EnumAttribute
 end

data/lib/enum/helpers/enum_column.rb

@@ -0,0 +1,34 @@
+require 'enum/helpers/enum_attribute'
+
+module Enum::Helpers::EnumColumn
+  include Enum::Helpers::EnumAttribute
+
+  # Bind a column to an enum by:
+  #   Generating attribute reader and writer to convert to EnumValue.
+  #   Creating a validation for the attribute so it must have valid enum values (allowing nil).
+  #   If :scoped => true, generates scopes and questioning methods for every name in the enum.
+  # If given a enum name (a symbol) and hash, also creates the enum.
+  def enum_column(attr, name_or_enum, options = {}, hash = nil)
+    # the first hash is either options or the hash if the options are missing
+    hash, options = options, {} unless name_or_enum.is_a?(Enum) or hash
+    # generating the enum attribute
+    e = attr_enum(attr, name_or_enum, options.merge(:qualifier => options[:scoped]), hash)
+    # validation
+    validates_inclusion_of attr, :in => e.values, :allow_nil => true
+    if options[:scoped]
+      # generating scopes and questioning methods
+      e.by_name.each do |n, ev|
+        scope n, where(attr => ev)
+        define_method("#{n}?") { self[attr] == ev }
+      end
+    end
+
+    e
+  end
+end
+
+if defined?(ActiveRecord)
+  class ActiveRecord::Base
+    extend Enum::Helpers::EnumColumn
+  end
+end

data/lib/enum/helpers.rb

@@ -2,4 +2,5 @@ module Enum::Helpers
 end
 
 require 'enum/helpers/enum_generator'
-require 'enum/helpers/enum_columns'
+require 'enum/helpers/enum_attribute'
+require 'enum/helpers/enum_column'

data/spec/lib/enum/helpers/enum_attribute_spec.rb

@@ -0,0 +1,128 @@
+require 'spec_helper'
+
+class UsesEnumAttribute < Hash # to allow setting 'attributes'
+  extend Enum::Helpers::EnumAttribute
+
+  class << self
+    # enum definition
+    def define_enum(attr, name_or_enum, options = {}, hash = nil)
+      @enum_name = name_or_enum.is_a?(Enum) ? name_or_enum.name : name_or_enum
+      attr_enum attr, name_or_enum, options, hash
+    end
+    def undefine_enum
+      remove_const :COLORS
+    end
+  end
+
+  # mocking setters
+  def method_missing(method, *args, &block)
+    if method.to_s.end_with?('=') and args.length == 1
+      self[method.to_s.chop.to_sym] = args.first
+    elsif method =~ /^[a-z_]*$/ and args.length == 0
+      self[method]
+    else
+      super
+    end
+  end
+end
+
+class UsesAnoterEnumAttribute < UsesEnumAttribute
+end
+
+def enum_generator_specs
+  describe Enum::Helpers::EnumGenerator do
+    subject { UsesEnumAttribute::COLORS }
+
+    its(:name) { should == :COLORS }
+    its(:klass) { should == UsesEnumAttribute }
+    its(:by_name) { should == { :red => 1, :blue => 2 } }
+  end # describe Enum::Helpers::EnumGenerator
+end
+
+def enum_attribute_specs
+  context "attributes" do
+    before do
+      @record = UsesEnumAttribute.new
+      @record[:color] = :unknown
+    end
+    subject { @record }
+
+    context "setter" do
+      specify "nil" do
+        @record.color = nil
+        @record[:color].should be_nil
+      end
+
+      specify "name" do
+        @record.color = :red
+        @record[:color].should be_enum_value and @record[:color].should be_red
+      end
+
+      specify "value" do
+        @record.color = 2
+        @record[:color].should be_enum_value and @record[:color].should be_blue
+      end
+
+      specify "invalid" do
+        expect { @record.color = 3 }.to raise_error(StandardError)
+      end
+    end # context "setter"
+
+    context "getter" do
+      specify "nil" do
+        @record[:color] = nil
+        @record.color.should be_nil
+      end
+
+      specify "value" do
+        @record[:color] = 2
+        @record.color.should be_enum_value and @record.color.should be_blue
+      end
+
+      specify "invalid" do
+        @record[:color] = 3
+        @record.color.should_not respond_to(:enum_value?) and @record.color.should == 3
+      end
+    end # context "getter"
+  end # context "attribute"
+end
+
+describe Enum::Helpers::EnumAttribute do
+  after { UsesEnumAttribute.undefine_enum }
+  subject { UsesEnumAttribute }
+
+  context "not qualifier" do
+    before { UsesEnumAttribute.define_enum(:color, :COLORS, :red => 1, :blue => 2) }
+
+    enum_generator_specs
+    enum_attribute_specs
+  end # context "not qualifier"
+
+  context "qualifier" do
+    before { UsesEnumAttribute.define_enum(:color, :COLORS, { :qualifier => true }, :red => 1, :blue => 2) }
+
+    enum_generator_specs
+    enum_attribute_specs
+
+    context "questions" do
+      before do
+        @record = UsesEnumAttribute.new
+        @record.color = :red
+      end
+      subject { @record }
+
+      it { should be_red }
+      it { should_not be_blue }
+    end # context "questions"
+  end # context "qualifier"
+
+  context "use another enum" do
+    before do
+      UsesEnumAttribute.define_enum(:color, :COLORS, { :qualifier => true }, :red => 1, :blue => 2)
+      UsesAnoterEnumAttribute.define_enum(:color, UsesEnumAttribute::COLORS)
+    end
+
+    enum_generator_specs
+    enum_attribute_specs
+  end
+end # describe Enum::Helpers::EnumAttribute

data/spec/{enum/helpers/enum_columns_spec.rb → lib/enum/helpers/enum_column_spec.rb}

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-class UsesEnumColumns < Hash # to allow setting 'attributes'
-  extend Enum::Helpers::EnumColumns
+class UsesEnumColumn < Hash # to allow setting 'attributes'
+  extend Enum::Helpers::EnumColumn
 
   class << self
     # enum definition
@@ -46,15 +46,15 @@ class UsesEnumColumns < Hash # to allow setting 'attributes'
   end
 end
 
-class UsesAnoterEnumColumns < UsesEnumColumns
+class UsesAnoterEnumColumn < UsesEnumColumn
 end
 
 def enum_generator_specs
   describe Enum::Helpers::EnumGenerator do
-    subject { UsesEnumColumns::COLORS }
+    subject { UsesEnumColumn::COLORS }
 
     its(:name) { should == :COLORS }
-    its(:klass) { should == UsesEnumColumns }
+    its(:klass) { should == UsesEnumColumn }
     its(:by_name) { should == { :red => 1, :blue => 2 } }
   end # describe Enum::Helpers::EnumGenerator
 end
@@ -62,7 +62,7 @@ end
 def enum_columns_attribute_specs
   context "attributes" do
     before do
-      @record = UsesEnumColumns.new
+      @record = UsesEnumColumn.new
       @record[:color] = :unknown
     end
     subject { @record }
@@ -112,19 +112,19 @@ def enum_columns_attribute_specs
   end # context "validations"
 end
 
-describe Enum::Helpers::EnumColumns do
-  after { UsesEnumColumns.undefine_enum }
-  subject { UsesEnumColumns }
+describe Enum::Helpers::EnumColumn do
+  after { UsesEnumColumn.undefine_enum }
+  subject { UsesEnumColumn }
 
   context "not scoped" do
-    before { UsesEnumColumns.define_enum(:color, :COLORS, :red => 1, :blue => 2) }
+    before { UsesEnumColumn.define_enum(:color, :COLORS, :red => 1, :blue => 2) }
 
     enum_generator_specs
     enum_columns_attribute_specs
   end # context "not scoped"
 
   context "scoped" do
-    before { UsesEnumColumns.define_enum(:color, :COLORS, { :scoped => true }, :red => 1, :blue => 2) }
+    before { UsesEnumColumn.define_enum(:color, :COLORS, { :scoped => true }, :red => 1, :blue => 2) }
 
     enum_generator_specs
     enum_columns_attribute_specs
@@ -137,7 +137,7 @@ describe Enum::Helpers::EnumColumns do
 
     context "questions" do
       before do
-        @record = UsesEnumColumns.new
+        @record = UsesEnumColumn.new
         @record.color = :red
       end
       subject { @record }
@@ -149,11 +149,11 @@ describe Enum::Helpers::EnumColumns do
 
   context "use another enum" do
     before do
-      UsesEnumColumns.define_enum(:color, :COLORS, { :scoped => true }, :red => 1, :blue => 2)
-      UsesAnoterEnumColumns.define_enum(:color, UsesEnumColumns::COLORS)
+      UsesEnumColumn.define_enum(:color, :COLORS, { :scoped => true }, :red => 1, :blue => 2)
+      UsesAnoterEnumColumn.define_enum(:color, UsesEnumColumn::COLORS)
     end
 
     enum_generator_specs
     enum_columns_attribute_specs
   end
-end # describe Enum::Helpers::EnumColumns
+end # describe Enum::Helpers::EnumColumn

data/yinum.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "yinum"
-  s.version     = "1.0.0"
+  s.version     = "1.1.0"
   s.authors     = ["Oded Niv"]
   s.email       = ["oded.niv@gmail.com"]
   s.homepage    = "https://github.com/toplex/enum"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yinum
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2013-03-06 00:00:00.000000000 Z
 dependencies: []
 description: Yummy implementation of enum that gives integer values with a special
   wrapping.
@@ -27,13 +27,15 @@ files:
 - lib/enum.rb
 - lib/enum/enum_value.rb
 - lib/enum/helpers.rb
-- lib/enum/helpers/enum_columns.rb
+- lib/enum/helpers/enum_attribute.rb
+- lib/enum/helpers/enum_column.rb
 - lib/enum/helpers/enum_generator.rb
 - lib/yinum.rb
-- spec/enum/enum_value_spec.rb
-- spec/enum/helpers/enum_columns_spec.rb
-- spec/enum/helpers/enum_generator_spec.rb
-- spec/enum_spec.rb
+- 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
 - yinum.gemspec
 homepage: https://github.com/toplex/enum
@@ -60,9 +62,4 @@ rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Enum implementation
-test_files:
-- spec/enum/enum_value_spec.rb
-- spec/enum/helpers/enum_columns_spec.rb
-- spec/enum/helpers/enum_generator_spec.rb
-- spec/enum_spec.rb
-- spec/spec_helper.rb
+test_files: []