acts_as_enumeration 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_enum.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul McKibbin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

data/README.md

@@ -0,0 +1,62 @@
+# ActsAsEnum
+
+acts_as_enumerable and its aliases acts_as_enum, enumerable_column and enum_column
+allow for unique names in a database column to behave as if they were enumerated
+types, including chaining etc.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_enum'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_enum
+
+## Usage
+
+So if a database table had a column called "name", declaring
+
+   acts_as_enumerable :name
+
+would select all of the items in that column and map them in a hash to their
+primary key values.
+
+In addition, it creates the instance methods is_#{key} where key is all of the
+values in that column, is?(array) and is_not?(array) that check for type within
+that array.
+
+Keeping name as our column example, the class methods id_for_name will return
+the primary key value for that mapping and valid_name?(value) will say if the
+table contains and entry in the name column with that value.
+
+Finally, the method missing allows for is_ and is_not chaining of methods, such
+as is_paul_or_michael_or_luke? which has the same effect as
+(is_paul? || is_michael? || is_luke?) or is?(:paul, :michael, :luke) and
+is_not_paul_or_michael_or_like which has the same effect as
+!(is_paul || is_michael? || is_luke?) or !is?(:paul, :michael, :luke)
+
+CAVEAT: due to the mechanism that the method_missing uses in is someone actually
+had the name "not bruce", the combinations cannot use this as the first element.
+i.e. "not <anything>" not just "not bruce".
+
+So a combination of is_not_bruce_or_paul? would have to be written
+is_paul_or_not_bruce? to have the desired effect. is_not_not_bruce_or_paul
+is fine, but the chances of this happening are about as likely as someone actually
+called "not bruce" outside of a Monty Python sketch.
+
+(Which means it probably will, so before you change code to support a new entry,
+try just changing the order)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/acts_as_enumeration.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_enumeration/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'acts_as_enumeration'
+  spec.version       = ActsAsEnumeration::VERSION
+  spec.authors       = ['Paul McKibbin']
+  spec.email         = ['pmckibbin@gmail.com']
+
+  spec.description   = %q(Active Record extender to enable the selection of a database column and have all of it's values enumerable)
+  spec.summary       = %q(enumerable values from database columns)
+  spec.homepage      = "http://blackrat.org"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/acts_as_enumeration/enumerable.rb

@@ -0,0 +1,100 @@
+module ActsAsEnumeration
+  def acts_as_enumerable(*args)
+    args.each do |column_name|
+
+      class_eval(%Q(
+        unless defined? @@enum_#{column_name}
+          @@enum_#{column_name}=Hash[*all.map{|x| [x.send(column_name).gsub(/[\\W]+/,' ').strip.gsub(/\s+/,'_').underscore.intern,x.send(x.class.primary_key)]}.flatten]
+        end
+      ), __FILE__, __LINE__+1)
+
+      all.map { |x| x.send(column_name).gsub(/[\W]+/, ' ').strip.gsub(/\s+/, '_').underscore.intern }.each do |y|
+        class_eval(%Q(
+          def is_#{y}?
+            is?("#{y}".intern)
+          end
+                   ), __FILE__, __LINE__+1)
+
+        identifier = y.to_s=~/^[a-z_]/ ? y.to_s : "_#{y.to_s}"
+        class_eval(%Q(
+          def #{identifier}?
+            is_#{y}?
+          end
+                   ), __FILE__, __LINE__+1)
+
+        class_eval(%Q(
+          def self.#{identifier}
+            for_#{column_name}("#{y}".intern)
+          end
+                   ), __FILE__, __LINE__+1)
+      end
+
+      class_eval(%Q(
+        def self.enum_#{column_name}
+          @@enum_#{column_name}
+        end
+      ), __FILE__, __LINE__+1)
+
+      class_eval(%Q(
+        def self.as_key(value)
+          return nil unless exists?(value)
+          find(value).as_key
+        end
+      ), __FILE__, __LINE__+1)
+
+      class_eval(%Q(
+        def self.valid_#{column_name}?(value)
+          @@enum_#{column_name}.keys.include?(value)
+        end
+      ), __FILE__, __LINE__+1)
+
+      class_eval(%Q(
+        def self.id_for_#{column_name}(value)
+          @@enum_#{column_name}[value]
+        end
+      ), __FILE__, __LINE__+1)
+
+      class_eval(%Q(
+        def self.for_#{column_name}(value)
+          find(id_for_#{column_name}(value))
+        end
+      ), __FILE__, __LINE__+1)
+
+      class_eval(%Q(
+        def is?(*types)
+          types.any?{|x| send(self.class.primary_key)==self.class.enum_#{column_name}[x]}
+        end
+      ), __FILE__, __LINE__+1)
+
+      class_eval(%Q(
+        def is_not?(*types)
+          !is?(*types)
+        end
+      ), __FILE__, __LINE__+1)
+
+      class_eval(%Q(
+        def as_key
+          #{column_name}.gsub(/[\\W]+/,' ').strip.gsub(/\s+/,'_').underscore.intern
+        end
+        alias_method :as_symbol, :as_key
+                 ))
+
+      class_eval(%Q(
+        def method_missing(method_id, *args, &block)
+          method_name=method_id.to_s
+          if match_data=method_name.match(/^(is[_not]*)(\\?|_(\\w*)\\?)/)
+            method=match_data[1] << "?"
+            new_args= ((match_data[2]=='?') ? args : match_data[3].split(/_or_/).map{|x| x.intern})
+            respond_to?(method) ? send(method,*new_args,&block) : false
+          else
+            super
+          end
+        end
+       ), __FILE__, __LINE__+1)
+    end
+  end
+
+  alias_method :acts_as_enumeration, :acts_as_enumerable
+  alias_method :enumerable_column, :acts_as_enumerable
+  alias_method :enum_column, :acts_as_enumerable
+end

data/lib/acts_as_enumeration/version.rb

@@ -0,0 +1,3 @@
+module ActsAsEnumeration
+  VERSION = "0.0.1"
+end

data/lib/acts_as_enumeration.rb

@@ -0,0 +1,6 @@
+require 'acts_as_enumeration/version'
+require 'acts_as_enumeration/enumerable'
+
+class ActiveRecord::Base
+  extend ActsAsEnumeration
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_enumeration
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul McKibbin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Active Record extender to enable the selection of a database column and
+  have all of it's values enumerable
+email:
+- pmckibbin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_enumeration.gemspec
+- lib/acts_as_enumeration.rb
+- lib/acts_as_enumeration/enumerable.rb
+- lib/acts_as_enumeration/version.rb
+homepage: http://blackrat.org
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: enumerable values from database columns
+test_files: []