iron-enum 1.0.4 → 1.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e8720fd7684984e779c2c1ec32303efa0bc4524
+  data.tar.gz: 25418ec2a560576081bab7141e409c750001793e
+SHA512:
+  metadata.gz: a4333e90565840188208a30f0f34bb16abddb6c7ff02dc3bd649b40c3de99128f14bbac2046373ec1a070456be76f4759ae6dbb0dd9fa9fa706cf2fdc0558f82
+  data.tar.gz: ca0e7f8ddfd034dcc65e22b6a2c0422f90fb0361f195a602277e574a0d5237760b0a1c1a8e43148a2f22215d3900c76b00fa9ffe0e2b8cf5d0f4a0d088597a6f

data/History.txt

@@ -1,3 +1,8 @@
+== 1.0.5 / 2016-08-16
+
+* Change enum_attr to assume :some_enum maps to SomeEnum module
+* Enable require 'iron-enum' instead of 'iron/enum'
+
 == 1.0.4 / 2013-06-21
 
 * Same as 1.0.4, but add support to model attributes as well (doh)

data/README.rdoc

@@ -11,7 +11,7 @@ Add support for rich enum values (enumerated constants) to Ruby/Rails.
 Managing constants - status flags, system states, etc - is frustrating when working
 with Ruby and Rails.  The canonical solution is to use class constants.  But doing so
 leaves a lot to be desired.  This gem provides a much more Ruby-like way of dealing
-with magic constants, that provides symbol/key-based lookup, automatic conversion between
+with magic constants that provides symbol/key-based lookup, automatic conversion between
 keys and values, user-friendly naming, attribute support, model scoping and validation, and more.
 
 To use:
@@ -30,16 +30,16 @@ To use:
       enum :returned,  5
     end
 
-    # Once you have your enum set up, there are a host of things you can do
-    # To start with, enums set up normal Ruby class constants
+    # Once you have your enum set up, there are a host of things you can do.
+    # To start with, enums set up normal Ruby class constants:
     >> puts OrderStatus::PURCHASED
     => 3
     
-    # But you can also refer to them with symbolic keys
+    # But you can also refer to them with symbolic keys:
     >> puts OrderStatus.value(:purchased)
     => 3
     
-    # You can convert between values, keys and text
+    # You can convert between values, keys and text:
     >> OrderStatus.value(:shipped)
     => 4
     >> OrderStatus.name(:shipped)
@@ -60,7 +60,11 @@ To use:
     
     # This is all handy, but where enums really shine is as declared attributes
     class Order < ActiveRecord::Base
+      # Pass the attribute and the enum module that it uses
       enum_attr :status => OrderStatus
+      
+      # Note that if your attribute's name maps to your enum module name, you can skip the hash:
+      # enum_attr :order_status
     end
     
     # Now you can set a value using a key
@@ -78,7 +82,7 @@ To use:
     # This raises RuntimeError('Unknown key or value [27] in enum OrderStatus')
     >> @order.status = 27
     
-    # You even get free scoping
+    # You even get free scoping!
     >> Order.with_status(:shipped)
     => [...all orders with status == 4...]
     
@@ -100,4 +104,8 @@ To install, simply run:
     
 RVM users can skip the sudo:
   
-    gem install iron-enum
+    gem install iron-enum
+    
+Once installed, just require it:
+
+    require 'iron-enum'

data/Version.txt

@@ -1 +1 @@
-1.0.4
+1.0.5

data/lib/iron-enum.rb

@@ -0,0 +1,2 @@
+# Make it easy to require using the gem name...
+require 'iron/enum'

data/lib/iron/enum/attr_support.rb

@@ -13,13 +13,19 @@ module Enum
   # declare it like so:
   #
   #   class User < ActiveRecord::Base
-  #     enum_attr :user_type => UserType
+  #     # A symbol will be assumed to map to a valid enum class name
+  #     enum_attr :user_type
+  #     # If your attribute's name won't map automatically, you can pass a hash instead
+  #     enum_attr :another_user_type => UserType
+  #     # If you have multiple enum attributes, you can add them all in one call, just make
+  #     # sure mapped attrs are at the end or you'll get an error
+  #     enum_attr :user_type, :another_user_type => UserType
   #   end
   #
   # When using non-model classes, it's the same syntax:
   #
   #   class User
-  #     enum_attr :user_type => UserType
+  #     enum_attr :user_type
   #   end
   #
   # This will tell your class/model that the user_type attribute contains values from the UserType enum, and
@@ -46,7 +52,22 @@ module Enum
   module AttrSupport
 
     # Call with enum_attr :field => Enum
-    def enum_attr(field_to_enum_map)
+    def enum_attr(*array_or_map)
+      # Convert to a full map
+      field_to_enum_map = {}
+      array_or_map.each do |info|
+        if info.is_a?(Symbol)
+          name = info.to_s.capitalize.gsub(/\_([a-z])/) { $1.capitalize }
+          klass = Object.const_get(name) rescue nil
+          raise "Unknown enum class '#{name}' for enum_attr :#{info}" unless klass
+          field_to_enum_map[info] = klass
+        elsif info.is_a?(Hash)
+          field_to_enum_map.merge!(info)
+        else
+          raise "Invalid enum_attr key: #{info.inspect}"
+        end
+      end
+      
       # Save off the attr map
       @enum_attrs ||= {}
       @enum_attrs.merge!(field_to_enum_map)

data/spec/enum/attr_spec.rb

@@ -8,6 +8,7 @@ describe Enum do
     
     class AttrClass
       enum_attr :pos => AttrTest
+      enum_attr :attr_test, :bob => AttrTest
     end
     
     before do
@@ -16,6 +17,8 @@ describe Enum do
     
     it 'should support declaring enum attributes' do
       Module.should respond_to(:enum_attr)
+      @obj.should respond_to(:attr_test_second?)
+      @obj.should respond_to(:bob_as_name)
     end
     
     it 'should allow getting an attribute in key form' do

data/spec/spec_helper.rb

@@ -16,6 +16,6 @@ require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'iron',
 RSpec.configure do |config|
   config.add_formatter 'documentation'
   config.color = true
-  config.backtrace_clean_patterns = [/rspec/]
+  config.backtrace_exclusion_patterns = [/rspec/]
 end
 

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: iron-enum
 version: !ruby/object:Gem::Version
-  version: 1.0.4
-  prerelease: 
+  version: 1.0.5
 platform: ruby
 authors:
 - Rob Morris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2016-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
 - !ruby/object:Gem::Dependency
   name: active_record
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 description: Adds enumerated constant value support to Ruby and Rails projects
@@ -66,10 +59,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- History.txt
+- LICENSE
+- README.rdoc
+- Version.txt
+- lib/iron-enum.rb
+- lib/iron/enum.rb
 - lib/iron/enum/attr_support.rb
 - lib/iron/enum/core.rb
 - lib/iron/enum/model_support.rb
-- lib/iron/enum.rb
 - spec/enum/attr_spec.rb
 - spec/enum/enum_spec.rb
 - spec/enum/key_spec.rb
@@ -78,34 +77,28 @@ files:
 - spec/enum/option_spec.rb
 - spec/enum/value_spec.rb
 - spec/spec_helper.rb
-- LICENSE
-- History.txt
-- Version.txt
-- README.rdoc
-- .rspec
 homepage: http://irongaze.com
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Enum support for Ruby and Rails
 test_files: []