enumattr 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/.rspec

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enumattr.gemspec
+gemspec
+
+group :development do
+  gem 'rspec'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 aisuii
+
+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,136 @@
+# Enumattr
+
+* manage constants by enum like object
+* simplify [SelectableAttr](https://github.com/akm/selectable_attr)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enumattr'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enumattr
+
+## Usage
+
+### defining
+
+* `include Enumattr::Base` and declare `enum_attr_for some_attribute do ... end`
+* `enum :symbol, value` in block
+
+
+<pre>
+class User
+  include Enumattr::Base
+
+  attr_accessor :status
+
+  enum_attr_for :status do
+    enum :active,  1
+    enum :suspend, 2
+    enum :deleted, 3
+  end
+
+  def initialize(status)
+    @status = status
+  end
+end
+</pre>
+
+### defined methods
+
+#### class methods
+
+* `SomeClass.#{some_attribute}_enums` return enum set
+* `SomeClass.#{some_attribute}_keys` return key set
+* `SomeClass.#{some_attribute}_values` return value set
+
+<pre>
+User.status_enums
+#=&gt; #&lt;Set: {#&lt;Enumattr::Enum:0x8a8d13c @key=:active, @value=1&gt;, #&lt;Enumattr::Enum:0x8a8d100 @key=:suspend, @value=2&gt;, #&lt;Enumattr::Enum:0x8a8d0ec @key=:deleted, @value=3&gt;}&gt;
+
+User.status_keys
+#=&gt; #&lt;Set: {:active, :suspend, :deleted}&gt;
+
+User.status_values
+#=&gt; #&lt;Set: {1, 2, 3}&gt;
+</pre>
+
+* `SomeClass.#{some_attribute}_enum_by_key(:symbol)` return an enum
+* `SomeClass.#{some_attribute}_value_by_key(:symbol)` return a value
+
+<pre>
+User.status_enum_by_key :active
+#=&gt; #&lt;Enumattr::Enum:0x8a8d13c @key=:active, @value=1&gt;
+
+User.status_enum_by_key :suspend
+#=&gt; #&lt;Enumattr::Enum:0x8a8d100 @key=:suspend, @value=2&gt;
+
+User.status_enum_by_key :dummy
+#=&gt; nil
+
+User.status_value_by_key :active
+#=&gt; 1
+
+User.status_value_by_key :suspend
+#=&gt; 2
+
+User.status_value_by_key :dummy
+#=&gt; nil
+</pre>
+
+#### instance methods
+
+* alias `#{some_attribute}_value` `some_attribute`
+* `#{some_attribute}_key` return symbol
+* `#{some_attribute}_enum` return enum
+
+<pre>
+user = User.new(1)
+#=&gt; #&lt;User:0x8e17dac @status=1&gt;
+
+user.status
+#=&gt; 1
+
+user.status_value # alias
+#=&gt; 1
+
+user.status_key
+#=&gt; :active
+
+user.status_enum
+#=&gt; #&lt;Enumattr::Enum:0x8de2e68 @key=:active, @value=1&gt;
+</pre>
+
+
+* define query method
+* `#{some_attribute}_#{some_symbol}?` return bool
+
+<pre>
+user.status_active?
+#=&gt; true
+
+user.status_suspend?
+#=&gt; false
+
+user.status_deleted?
+#=&gt; false
+
+user.status_dummy?
+NoMethodError: undefined method `status_dummy?' for #&lt;User:0x8e17dac @status=1&gt;
+</pre>
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec)

data/enumattr.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/enumattr/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["aisuii"]
+  gem.email         = ["aisuiiaisuii@gmail.com"]
+  gem.description   = %q{simple enum}
+  gem.summary       = %q{manage constants by enum like object}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "enumattr"
+  gem.require_paths = ["lib"]
+  gem.version       = Enumattr::VERSION
+end

data/examples/user.rb

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+class User
+  include Enumattr::Base
+
+  attr_accessor :status
+
+  enum_attr_for :status do
+    enum :active,  1
+    enum :suspend, 2
+    enum :deleted, 3
+  end
+
+  def initialize(status)
+    @status = status
+  end
+end

data/lib/enumattr/base.rb

@@ -0,0 +1,82 @@
+# -*- encoding: utf-8 -*-
+
+module Enumattr
+  module Base
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      private
+      def enum_attr_for(enum_attr_name, &block)
+        enum_attrs[enum_attr_name] = Enums.new(&block)
+        define_class_methods enum_attr_name
+        define_instance_methods enum_attr_name
+        define_instance_query_methods enum_attr_name
+      end
+
+      def enum_attrs
+        @enum_attrs ||= {}
+      end
+
+      def define_class_methods(enum_attr_name)
+        enums = enum_attrs[enum_attr_name]
+        method_prefix = "#{enum_attr_name}_"
+
+        mod = Module.new do
+          define_method("#{method_prefix}enums") do
+            enums.enums
+          end
+
+          define_method("#{method_prefix}keys") do
+            enums.keys
+          end
+
+          define_method("#{method_prefix}values") do
+            enums.values
+          end
+
+          define_method("#{method_prefix}enum_by_key") do |key|
+            enums.enum_by_key(key)
+          end
+
+          define_method("#{method_prefix}value_by_key") do |key|
+            enum = enums.enum_by_key(key)
+            enum && enum.value
+          end
+        end
+
+        extend mod
+      end
+
+      def define_instance_methods(enum_attr_name)
+        enums = enum_attrs[enum_attr_name]
+        method_prefix = "#{enum_attr_name}_"
+
+        define_method("#{method_prefix}enum") do
+          value = __send__ enum_attr_name
+          enums.enum_by_value(value)
+        end
+
+        define_method("#{method_prefix}key") do
+          enum = __send__ "#{method_prefix}enum"
+          enum.key
+        end
+
+        alias_method :"#{method_prefix}value", enum_attr_name
+      end
+
+      def define_instance_query_methods(enum_attr_name)
+        enums = enum_attrs[enum_attr_name]
+        method_prefix = "#{enum_attr_name}_"
+
+        enums.enums.each do |enum|
+          define_method("#{method_prefix}#{enum.key}?") do
+            value = __send__ enum_attr_name
+            value == enum.value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/enumattr/enum.rb

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+
+module Enumattr
+  class Enum
+    attr_reader :key, :value
+
+    def initialize(key, value)
+      @key = key.to_sym
+      @value = value
+    end
+
+    def hash
+      @key.hash
+    end
+
+    def eql?(other)
+      @key == other.key
+    end
+  end
+end

data/lib/enumattr/enums.rb

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+require 'set'
+
+module Enumattr
+  class Enums
+    def initialize(&block)
+      @set = Set.new
+      instance_eval(&block)
+      freeze
+    end
+
+    def enums
+      @set.clone
+    end
+
+    def keys
+      Set.new @set.map(&:key)
+    end
+
+    def values
+      Set.new @set.map(&:value)
+    end
+
+    def enum_by_key(key)
+      @set.find{|enum| enum.key == key }
+    end
+
+    def enum_by_value(value)
+      @set.find{|enum| enum.value == value }
+    end
+
+    private
+    def enum(key, value)
+      @set.add Enum.new(key, value)
+    end
+  end
+end

data/lib/enumattr/version.rb

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

data/lib/enumattr.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+require "enumattr/version"
+
+module Enumattr
+  autoload :Base,  'enumattr/base'
+  autoload :Enums, 'enumattr/enums'
+  autoload :Enum,  'enumattr/enum'
+end

data/spec/enumattr/enum_spec.rb

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe Enumattr::Enum do
+  let(:one_enum)      { Enumattr::Enum.new(:my_key, 1) }
+  let(:same_key_enum) { Enumattr::Enum.new(:my_key, 2) }
+  let(:another_enum)  { Enumattr::Enum.new(:another, 3) }
+
+  describe "getters" do
+    subject { one_enum }
+    its(:key)  { should == :my_key }
+    its(:value) { should == 1 }
+  end
+
+  describe "in hash key" do
+    context "when hash has same key enum as hash key" do
+      subject do
+        hash = {}
+        hash[one_enum]       = 1
+        hash[same_key_enum]  = 2 # only value overrided
+        hash[another_enum]   = 3
+        hash
+      end
+
+      its(:keys) { should     include one_enum      }
+      its(:keys) { should_not include same_key_enum }
+      its(:keys) { should     include another_enum  }
+
+      its(:values) { should_not include 1 }
+      its(:values) { should     include 2 }
+      its(:values) { should     include 3 }
+
+      it "should have 2 items" do
+        subject.should have(2).items
+      end
+    end
+  end
+end

data/spec/enumattr/enums_spec.rb

@@ -0,0 +1,84 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+
+describe Enumattr::Enums do
+  let(:enums) do
+    Enumattr::Enums.new do
+      enum :key1, 1
+      enum :key2, 2
+      enum :key3, 3
+    end
+  end
+
+  describe "#enums" do
+    subject { enums.enums }
+    it { should be_a Set }
+    it { should have(3).items }
+    it "should have Enumattr::Enum instances" do
+      should satisfy { |enums|
+        enums.all?{|item| item.is_a? Enumattr::Enum }
+      }
+    end
+  end
+
+  describe "#keys" do
+    subject { enums.keys }
+    it { should be_a Set }
+    it { should have(3).items }
+    it "should have Symbol instances" do
+      should satisfy { |keys|
+        keys.all?{|item| item.is_a? Symbol }
+      }
+    end
+  end
+
+  describe "#values" do
+    subject { enums.values }
+    it { should be_a Set }
+    it { should have(3).items }
+    it "should have Numeric instances" do
+      should satisfy { |values|
+        values.all?{|item| item.is_a? Numeric }
+      }
+    end
+  end
+
+  describe "find methods" do
+    shared_examples "#enum_by_foo(foo) each items" do
+      it { should be_a Enumattr::Enum }
+      its(:key)   { should == expects[:key] }
+      its(:value) { should == expects[:value] }
+    end
+
+    samples = [
+      {:key => :key1, :value => 1},
+      {:key => :key2, :value => 2},
+      {:key => :key3, :value => 3},
+    ]
+
+    describe "#enum_by_key(key)" do
+      subject { enums.enum_by_key(key) }
+      samples.each do |sample|
+        context "key: #{sample[:key]}" do
+          let(:key) { sample[:key] }
+          let(:expects) { sample }
+
+          include_examples "#enum_by_foo(foo) each items"
+        end
+      end
+    end
+
+    describe "#enum_by_value(value)" do
+      subject { enums.enum_by_value(value) }
+
+      samples.each do |sample|
+        context "value: #{sample[:value]}" do
+          let(:value) { sample[:value] }
+          let(:expects) { sample }
+
+          include_examples "#enum_by_foo(foo) each items"
+        end
+      end
+    end
+  end
+end

data/spec/enumattr/included_spec.rb

@@ -0,0 +1,116 @@
+# -*- encoding: utf-8 -*-
+require 'spec_helper'
+require 'user'
+
+describe User do
+  describe "class methods" do
+    describe '.status_enums as #{enum_attr_name}_enums' do
+      subject { described_class.status_enums }
+
+      it { should be_a Set }
+      it { should have(3).items }
+      it "should have Enum instances" do
+        should satisfy { |enums|
+          enums.all?{|item| item.is_a? Enumattr::Enum }
+        }
+      end
+    end
+
+    describe '.status_keys as #{enum_attr_name}_keys' do
+      subject { described_class.status_keys }
+
+      it { should be_a Set }
+      it { should have(3).items }
+      it "should have Symbol instances" do
+        should satisfy { |keys|
+          keys.all?{|item| item.is_a? Symbol }
+        }
+      end
+    end
+
+    describe '.status_values as #{enum_attr_name}_values' do
+      subject { described_class.status_values }
+
+      it { should be_a Set }
+      it { should have(3).items }
+      it "should have Numeric instances" do
+        should satisfy { |values|
+          values.all?{|item| item.is_a? Numeric }
+        }
+      end
+    end
+
+    describe '.status_enum_by_key as #{enum_attr_name}_enum_by_key' do
+      subject { described_class.status_enum_by_key(:active) }
+
+      it { should be_a Enumattr::Enum }
+      its(:key) { should == :active }
+      its(:value) { should == 1 }
+    end
+
+    describe '.status_value_by_key as #{enum_attr_name}_value_by_key' do
+      context "present key" do
+        subject { described_class.status_value_by_key(:active) }
+
+        it { should == 1 }
+      end
+
+      context "not present key" do
+        subject { described_class.status_value_by_key(:not_present_key) }
+
+        it { should be_nil }
+      end
+    end
+  end
+
+
+  describe "instance methods" do
+    let(:user) { User.new(1) }
+
+    describe "#status" do
+      subject { user.status }
+
+      it { should == 1 }
+    end
+
+    describe '#status_enum as #{enum_attr_name}_enum' do
+      subject { user.status_enum }
+
+      it { should be_a Enumattr::Enum }
+      its(:key)   { should == :active }
+      its(:value) { should == 1 }
+    end
+
+    describe '#status_key as #{enum_attr_name}_key' do
+      subject { user.status_key }
+
+      it { should be_a Symbol }
+      it { should == :active }
+    end
+
+    describe '#status_value as #{enum_attr_name}_value' do
+      subject { user.status_value }
+
+      it { should be_a Numeric }
+      it { should == 1 }
+    end
+
+    describe '#status_active? as #{enum_attr_name}_#{status_key}?' do
+      subject { user.status_active? }
+
+      it { should be_true }
+    end
+
+    describe '#status_suspend? as #{enum_attr_name}_#{other_status_key}?' do
+      subject { user.status_suspend? }
+
+      it { should be_false }
+    end
+
+    describe '#status_deleted? as #{enum_attr_name}_#{other_status_key}?' do
+      subject { user.status_deleted? }
+
+      it { should be_false }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'examples'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'enumattr'
+
+# 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.rb"` 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
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: enumattr
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- aisuii
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-27 00:00:00.000000000 Z
+dependencies: []
+description: simple enum
+email:
+- aisuiiaisuii@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- enumattr.gemspec
+- examples/user.rb
+- lib/enumattr.rb
+- lib/enumattr/base.rb
+- lib/enumattr/enum.rb
+- lib/enumattr/enums.rb
+- lib/enumattr/version.rb
+- spec/enumattr/enum_spec.rb
+- spec/enumattr/enums_spec.rb
+- spec/enumattr/included_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.21
+signing_key: 
+specification_version: 3
+summary: manage constants by enum like object
+test_files:
+- spec/enumattr/enum_spec.rb
+- spec/enumattr/enums_spec.rb
+- spec/enumattr/included_spec.rb
+- spec/spec_helper.rb