act_as_enumerable 0.1.0

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: ZzfF046txNMxLkyoa2fpjrANjsILZNGuJ

data/.gitignore

@@ -0,0 +1,18 @@
+*.rbc
+*.sassc
+.sass-cache
+.rvmrc
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+*.gem

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rake', '~> 10.0.3'
+  gem 'minitest', '~> 4.4.0'
+  gem 'turn', '~> 0.9.3'
+  gem 'shoulda', '~> 3.3.2'
+  gem 'coveralls', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    act_as_enumerable (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    ansi (1.4.3)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    colorize (0.5.8)
+    coveralls (0.5.5)
+      colorize
+      json
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    i18n (0.6.1)
+    json (1.7.6)
+    metaclass (0.0.1)
+    mime-types (1.19)
+    minitest (4.4.0)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.5.0)
+    rake (10.0.3)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.2)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.16.0)
+    turn (0.9.6)
+      ansi
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  act_as_enumerable!
+  coveralls
+  minitest (~> 4.4.0)
+  rake (~> 10.0.3)
+  shoulda (~> 3.3.2)
+  turn (~> 0.9.3)

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright 2012 caedes
+
+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,80 @@
+# ActAsEnumerable
+
+[![Build Status][travis-img]][travis-url] [![Coveralls][coveralls-img]][coveralls-url] [![Dependency Status][gemnasium-img]][gemnasium-url] [![Code Climate][codeclimate-img]][codeclimate-url] [![Gem Version][gemversion-img]][gemversion-url]
+
+_Add enumeration to your ruby classes_
+
+## Installation
+
+```shell
+gem install act_as_enumerable
+```
+
+Or in your Gemfile:
+
+```ruby
+gem 'act_as_enumerable'
+```
+
+## Usage
+
+```ruby
+class Person
+  attr_accessor :gender
+
+  def initialize opts
+    @gender = opts[:gender]
+  end
+
+  enum :gender, %w(male female)
+end
+
+cameron = Person.new gender: :male
+
+p Person.gender_values
+#=> ['male', 'female']
+
+p Person.gender_captions
+#=> ['Male', 'Female']
+
+p cameron.gender
+#=> 'male'
+
+p cameron.male?
+#=> true
+p cameron.female?
+#=> false
+
+p cameron.female!
+#=> 'female'
+p cameron.male?
+#=> false
+p cameron.female?
+#=> true
+
+p cameron.gender_caption
+#=> 'Female'
+```
+
+## Contributing
+
+1. Fork repository
+2. Create a branch following a [successfull branching model](http://nvie.com/posts/a-successful-git-branching-model/)
+3. Write your feature/fix
+4. Write tests
+5. Pull request
+
+## Licence
+
+Released under the MIT License. See the [LICENSE](https://github.com/caedes/act_as_enumerable/blob/master/LICENSE.md) file for further details.
+
+[travis-img]: https://secure.travis-ci.org/caedes/act_as_enumerable.png?branch=master
+[travis-url]: http://travis-ci.org/caedes/act_as_enumerable
+[coveralls-img]: https://coveralls.io/repos/caedes/act_as_enumerable/badge.png?branch=master
+[coveralls-url]: https://coveralls.io/r/caedes/act_as_enumerable
+[gemnasium-img]: https://gemnasium.com/caedes/act_as_enumerable.png
+[gemnasium-url]: https://gemnasium.com/caedes/act_as_enumerable
+[codeclimate-img]: https://codeclimate.com/badge.png
+[codeclimate-url]: https://codeclimate.com/github/caedes/act_as_enumerable
+[gemversion-img]: https://badge.fury.io/rb/act_as_enumerable.png
+[gemversion-url]: http://badge.fury.io/rb/act_as_enumerable

data/Rakefile

@@ -0,0 +1,17 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task default: :test

data/act_as_enumerable.gemspec

@@ -0,0 +1,20 @@
+require File.expand_path('../lib/act_as_enumerable/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'act_as_enumerable'
+  s.version     = ActAsEnumerable::VERSION
+  s.authors     = ['caedes']
+  s.email       = ['laurentromain@gmail.com']
+  s.homepage    = 'https://github.com/caedes/act_as_enumerable'
+  s.summary     = 'Add enumeration to your ruby classes'
+  s.description = s.summary
+
+  s.files        = `git ls-files`.split("\n")
+
+  s.require_path = 'lib'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'turn', '~> 0.9.3'
+  s.add_development_dependency 'shoulda', '~> 3.1.1'
+end

data/init.rb

@@ -0,0 +1 @@
+require 'act_as_enumerable'

data/lib/act_as_enumerable/version.rb

@@ -0,0 +1,3 @@
+module ActAsEnumerable
+  VERSION = '0.1.0'
+end

data/lib/act_as_enumerable.rb

@@ -0,0 +1,54 @@
+require 'act_as_enumerable/version'
+
+unless String.methods.include? 'underscore'
+  class String
+    def underscore
+      self.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+  end
+end
+
+class Object
+  def self.enum name, enumeration
+    name = name.to_s
+    class_eval "
+      attr_accessor :#{name}
+      def self.#{name}_values
+        #{enumeration}
+      end
+      def self.#{name}_captions
+        #{enumeration}.map do |value|
+          humanize_#{name} value
+        end
+      end"
+    enumeration.each do |value|
+      value = value.to_s
+      eval "
+        def #{value}?
+          self.#{name} == '#{value}'
+        end
+        def #{value}!
+          self.#{name} = '#{value}'
+        end"
+    end
+    eval "
+      def humanize_#{name} value
+        value = value.to_s
+        begin
+          Required::Module::const_get 'I18n'
+          ::I18n.t \"enum.#{self.to_s.underscore}.#{name}.#{'#{value}'}\"
+        rescue NameError
+          value
+        end
+      end
+      def #{name}_caption
+        self.#{name}.nil? ? self.#{name} : humanize_#{name}(self.#{name})
+      end"
+
+    # validates_inclusion_of name.to_sym, { allow_nil: true, in: enumeration } if self.ancestors.include? 'ActiveRecord::Base'
+  end
+end

data/test/act_as_enumerable_test.rb

@@ -0,0 +1,79 @@
+require 'test/unit'
+begin; require 'turn/autorun'; rescue LoadError; end
+require 'act_as_enumerable'
+require 'shoulda'
+
+require 'coveralls'
+Coveralls.wear!
+
+class EnumPlusTest < Test::Unit::TestCase
+
+  context 'when defining a new object' do
+    setup do
+      class EnumPlusTest
+      end
+
+      @enum_plus_test = EnumPlusTest.new
+    end
+
+    should 'define :enum' do
+      assert EnumPlusTest.singleton_methods.include? :enum
+    end
+  end
+
+  context 'with an object using :enum method (e.g. :gender)' do
+    setup do
+      class EnumPlusTest
+        enum :gender, %w(male female)
+      end
+
+      @enum_plus_test = EnumPlusTest.new
+    end
+
+    should 'define `gender_values` method' do
+      assert EnumPlusTest.singleton_methods.include? :gender_values
+      assert_equal %w(male female), EnumPlusTest.gender_values
+    end
+
+    context 'without I18n' do
+      should 'define `gender_caption` method' do
+        assert EnumPlusTest.singleton_methods.include? :gender_captions
+        assert_equal %w(male female), EnumPlusTest.gender_captions
+      end
+
+      should 'define `.humanize_gender` method' do
+        assert @enum_plus_test.methods.include? :humanize_gender
+
+        %w(male female).each do |value|
+          assert_equal value, @enum_plus_test.humanize_gender(value.to_sym)
+        end
+      end
+
+      context 'without setting :gender' do
+        should 'define `.gender_caption` method' do
+          assert @enum_plus_test.methods.include? :gender_caption
+          assert_equal nil, @enum_plus_test.gender_caption
+        end
+        %w(male female).each do |value|
+          should "define `.#{value}?` method" do
+            assert @enum_plus_test.methods.include? "#{value}?".to_sym
+            %w(male female).each do |value2|
+              assert_equal false, @enum_plus_test.send("#{value}?".to_sym)
+            end
+          end
+        end
+      end
+
+      context 'with setting :gender' do
+        %w(male female).each do |value|
+          setup { @enum_plus_test.gender = value }
+
+          should "define `.#{value}?` method" do
+            assert @enum_plus_test.methods.include? "#{value}?".to_sym
+          end
+        end
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: act_as_enumerable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- caedes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-18 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+description: Add enumeration to your ruby classes
+email:
+- laurentromain@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .coveralls.yml
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- act_as_enumerable.gemspec
+- init.rb
+- lib/act_as_enumerable.rb
+- lib/act_as_enumerable/version.rb
+- test/act_as_enumerable_test.rb
+homepage: https://github.com/caedes/act_as_enumerable
+licenses: []
+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.23
+signing_key: 
+specification_version: 3
+summary: Add enumeration to your ruby classes
+test_files: []