ez_enum 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 591248acf08c3df9097d00e274ace4789dce0bd5
+  data.tar.gz: 20003050e42cb1ec4d760dd39da1beb033d7ee3a
+SHA512:
+  metadata.gz: 2d1e40be0d043bedf7a63855d8cd1b5a7a306bd3c3e8ca2d8e59e50d339867ec17acf211274dc94dd5c32972711122a9de353217b2cff2fd58ceee44e3e9d383
+  data.tar.gz: 74984966eb4edf650606041bf604e5bd2e6790f7a17e0df9e14e84728ad3eb4ccb2d102df4662608ab17f74d27e476b0990f11495e622c725b50093900fb9747

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Stefano
+
+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,80 @@
+# EZEnum
+
+Provides a simple abstraction for defining enumerations in a Ruby module. Supports listing members and localization of constant names.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ez_enum'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ez_enum
+
+## Usage
+
+Define a Ruby module, giving it the name of the desired enumeration. Add constants to the module as needed.
+Include `EZEnum` into your module _after_ all constant declarations. E.g.
+
+```ruby
+module Status
+
+  New = 1
+  Processing = 2
+  Failed = 3
+  Complete = 4
+
+  # included here, so that constants are used
+  include EZEnum
+
+end
+```
+
+Your module will now include an `All` constant, which contains an array of the constants defined in the module. E.g.
+
+```ruby
+Status::All # => [New, Processing, Failed, Complete]
+```
+
+Your will also have the following helper methods add to it:
+
+* `choices_for_select` - returns an array of the localized names and values for each constant. E.g.
+
+  ```ruby
+  Status.choices_for_select # => [['New', 1], ['Processing', 2], ...]
+  ```
+
+* `display_for(value)` - returns the localized name for the given constant value. E.g.
+
+  ```ruby
+  Status.display_for(Status::Failed) # => 'Epic Fail'
+  ```
+
+To add support for localization, add sections under the respective language code in your locales file, and using the
+downcased name of the module and the downcased name of the constant, provide the corresponding translation. E.g.
+
+```yaml
+en:
+  enums:
+    status:
+      new: New
+      processing: Processing
+      failed: Epic Fail
+      completed: Completed
+```
+
+## 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
+
+## Copyright
+MIT License - Copyright (c) 2013 Chris Stefano

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler' rescue 'You must `gem install bundler` and `bundle install` to run rake tasks'
+require "bundler/gem_tasks"
+
+require "rspec"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec') do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  # spec.rspec_opts = '--order rand:16996'
+end
+
+task :default => :spec
+
+namespace :ez_enum do
+  # TODO
+end

data/ez_enum.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ez_enum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ez_enum"
+  spec.version       = EZEnum::VERSION
+  spec.authors       = ["Chris Stefano"]
+  spec.email         = ["virtualstaticvoid@gmail.com"]
+  spec.description   = %q{Provides a simple abstraction for defining enumerations in a Ruby module. Supports listing members and localization of constant names.}
+  spec.summary       = %q{Elegant Enumerations for Ruby and Rails}
+  spec.homepage      = "https://github.com/virtualstaticvoid/ez_enum"
+  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_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/ez_enum.rb

@@ -0,0 +1,50 @@
+require 'i18n'
+require 'active_support/inflector'
+
+module EZEnum
+
+  class << self
+
+    def included(base)
+
+      const_names = base.constants(false)
+
+      const_names_by_value = const_names.inject({}) do |list, name|
+        list[base.const_get(name)] = name
+        list
+      end
+
+      # add an "All" constant
+      base.const_set :All, const_names_by_value.keys
+
+      # add helper methods to module
+      base.class_eval do
+
+        # provides an array of display and values pairs
+        # typcially for use in HTML select controls
+        define_singleton_method :choices_for_select do
+          const_names_by_value.collect do |value, name|
+            [translate_display_for(name), value]
+          end
+        end
+
+        # resolves for the display name for the given value
+        define_singleton_method :display_for do |value|
+          translate_display_for(const_names_by_value[value])
+        end
+
+        private
+
+        # lookup i18n translation for given name
+        define_singleton_method :translate_display_for do |const_name|
+          I18n.translate(
+            const_name.to_s.underscore.to_sym,
+            :scope => [:enums, base.name.underscore],
+            :default => const_name.to_s
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/ez_enum/version.rb

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

data/spec/examples/status_enum.rb

@@ -0,0 +1,12 @@
+require 'ez_enum'
+
+module Status
+
+  New = 1
+  Processing = 2
+  Failed = 3
+  Complete = 4
+
+  include EZEnum
+
+end

data/spec/ez_enum/ez_enum_spec.rb

@@ -0,0 +1,41 @@
+require './spec/spec_helper'
+
+describe "ez_enum" do
+
+  before do
+    I18n.locale = :en
+  end
+
+  AllStatuses = [Status::New, Status::Processing, Status::Failed, Status::Complete]
+
+  describe "::All" do
+    it { defined?(Status::All).should_not be nil }
+    it { Status::All.should eq(AllStatuses) }
+  end
+
+  describe ".choices_for_select" do
+    it { Status.respond_to?(:choices_for_select).should be true }
+    it { Status.choices_for_select.should_not be nil }
+    it { Status.choices_for_select.length.should eq(AllStatuses.length) }
+    it { Status.choices_for_select.first.should eq(['New', 1])}
+    it "has correct display for switch in locale" do
+      I18n.locale = :af
+      Status.choices_for_select.first.should eq(['Nuwe', 1])
+    end
+  end
+
+  describe ".display_for" do
+    it { Status.respond_to?(:display_for).should be true }
+    it "provides display_for each member" do
+      Status::All.each do |status|
+        Status.display_for(status).should_not be nil
+      end
+    end
+    it { Status.display_for(Status::Failed).should eq('Epic Fail') }
+    it "has correct display for switch in locale" do
+      I18n.locale = :af
+      Status.display_for(Status::Failed).should eq('Gebreek')
+    end
+  end
+
+end

data/spec/locale/af.yml

@@ -0,0 +1,10 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+af:
+  enums:
+    status:
+      new: Nuwe
+      processing: Verwerking
+      failed: Gebreek
+      completed: Voltooi

data/spec/locale/en.yml

@@ -0,0 +1,10 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  enums:
+    status:
+      new: New
+      processing: Processing
+      failed: Epic Fail
+      completed: Completed

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+# Load examples
+Dir["./spec/examples/**/*.rb"].sort.each {|f| require f }
+
+# Load translations
+I18n.load_path = ['./spec/locale/en.yml', './spec/locale/af.yml']

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: ez_enum
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Stefano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides a simple abstraction for defining enumerations in a Ruby module.
+  Supports listing members and localization of constant names.
+email:
+- virtualstaticvoid@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ez_enum.gemspec
+- lib/ez_enum.rb
+- lib/ez_enum/version.rb
+- spec/examples/status_enum.rb
+- spec/ez_enum/ez_enum_spec.rb
+- spec/locale/af.yml
+- spec/locale/en.yml
+- spec/spec_helper.rb
+homepage: https://github.com/virtualstaticvoid/ez_enum
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Elegant Enumerations for Ruby and Rails
+test_files:
+- spec/examples/status_enum.rb
+- spec/ez_enum/ez_enum_spec.rb
+- spec/locale/af.yml
+- spec/locale/en.yml
+- spec/spec_helper.rb