mixin-enum 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db59b930505dec871b9b96905cf8288cfe8ee4f9
-  data.tar.gz: 7eba20e8a5cc908b6c59f5161df515c233a5d280
+  metadata.gz: b55f133227cd22d98bb406d1cdcdd9df0393580e
+  data.tar.gz: 6294618878cbad5941fa9fc4bd802bc6a83a56ec
 SHA512:
-  metadata.gz: 5fea717f2c80e4e7d75a1f7569e4ee60dc3ca80c72ab7276ff41261e27649b6415a11aa6afec87100ebf5f114c6019aace1582f22a79c7efdd875cb478757162
-  data.tar.gz: f8d01e16417ba9eaf503b02c0ae19a67fe29df6593f2cc336d2c68ab1df7db873da3a1fa9a3c6b9aed89f26f9ec75e56c479008348180fe0d6ae4fc7420ae6b6
+  metadata.gz: 07b9f3782c8ae10177b882ea642a329c3b4e42f677683a3c80ba0835044391813e7fc1b458e3d4a60e01338de758c3cea9593a6b6ceb2fdbac32f90110768799
+  data.tar.gz: d82e4dd761daf19318bc6c4395b943a900630342bd27afb8e44be1162423884ea23471f4e9b232336f4ab2cc6e8081cd6c6b3cefefd50c9468b926a945eb00f5

data/README.md

@@ -1,5 +1,6 @@
 # Mixin::Enum
 
+[![Gem Version](https://badge.fury.io/rb/mixin-enum.svg)](https://badge.fury.io/rb/mixin-enum)
 [![Build Status](https://travis-ci.org/yulii/mixin-enum.svg?branch=master)](https://travis-ci.org/yulii/mixin-enum)
 [![Coverage Status](https://coveralls.io/repos/github/yulii/mixin-enum/badge.svg?branch=master)](https://coveralls.io/github/yulii/mixin-enum?branch=master)
 
@@ -13,17 +14,33 @@ Add this line to your application's Gemfile:
 gem 'mixin-enum'
 ```
 
-And then execute:
-
-    $ bundle
+## Usage
 
-Or install it yourself as:
+Include Mixin::Enum and define constants on the module. You can see [the examples of enumeration module file](https://github.com/yulii/mixin-enum/tree/master/examples).
 
-    $ gem install mixin-enum
 
-## Usage
+```ruby
+module StatusCode
+  include Mixin::Enum
+
+  enumerated do
+    set(:REQUESTED,    1)
+    set(:IN_PROGRESS,  2)
+    set(:UNDER_REVIEW, 3)
+    set(:APPROVED,     4)
+    set(:REJECTED,     5)
+    set(:CANCELLED,    6)
+  end
+end
+
+irb> StatusCode::REQUESTED
+=> 1
+irb> StatusCode.values
+=> [1, 2, 3, 4, 5, 6]
+irb> StatusCode.all
+=> {:REQUESTED=>1, :IN_PROGRESS=>2, :UNDER_REVIEW=>3, :APPROVED=>4, :REJECTED=>5, :CANCELLED=>6}
+```
 
-TODO: Write usage instructions here
 
 ## Development
 

data/examples/status.rb

@@ -1,10 +1,12 @@
 module Status
   include Mixin::Enum
 
-  REQUESTED    = 1
-  IN_PROGRESS  = 2
-  UNDER_REVIEW = 3
-  APPROVED     = 4
-  REJECTED     = 5
-  CANCELLED    = 6
+  enumerated(:code, :text) do
+    set(:REQUESTED,    1, 'Requested')
+    set(:IN_PROGRESS,  2, 'In progress')
+    set(:UNDER_REVIEW, 3, 'Under review')
+    set(:APPROVED,     4, 'Approved')
+    set(:REJECTED,     5, 'Rejected')
+    set(:CANCELLED,    6, 'Cancelled')
+  end
 end

data/examples/status_code.rb

@@ -0,0 +1,12 @@
+module StatusCode
+  include Mixin::Enum
+
+  enumerated do
+    set(:REQUESTED,    1)
+    set(:IN_PROGRESS,  2)
+    set(:UNDER_REVIEW, 3)
+    set(:APPROVED,     4)
+    set(:REJECTED,     5)
+    set(:CANCELLED,    6)
+  end
+end

data/examples/status_flow.rb

@@ -0,0 +1,18 @@
+#    |- CANCELLED <-|
+#    |              |
+# REQUESTED -> IN PROGRESS -> UNDER REVIEW -> APPROVED
+#                   ^                 |
+#                   |-   REJECTED   <-|
+
+# module Statusflow
+#   include Mixin::Enum
+#
+#   enumerated(:code, :text) do
+#     set(:REQUESTED,    1, 'Requested')
+#     set(:IN_PROGRESS,  2, 'In progress')
+#     set(:UNDER_REVIEW, 3, 'Under review')
+#     set(:APPROVED,     4, 'Approved')
+#     set(:REJECTED,     5, 'Rejected')
+#     set(:CANCELLED,    6, 'Cancelled')
+#   end
+# end

data/lib/mixin/enum.rb

@@ -1,28 +1,31 @@
 require 'mixin/enum/version'
+require 'mixin/enum/accessor'
+require 'mixin/enum/binder'
+
+require 'mixin/enum/factor_factory'
+
+require 'mixin/enum/factor/base'
+require 'mixin/enum/factor/object'
+require 'mixin/enum/factor/struct'
 
 module Mixin
   module Enum
     def self.included(klass)
       klass.extend ClassMethods
+      # NOTE: Ruby 2.0
+      if klass.private_methods.include?(:include)
+        klass.extend Accessor::ClassMethods
+        klass.extend Binder::ClassMethods
+      else
+        klass.include Accessor
+        klass.include Binder
+      end
     end
 
     module ClassMethods
-      def values
-        constant_pairs.map(&:last)
-      end
-
-      def all
-        Hash[constant_pairs]
-      end
-
-      private
-
-      def origin_constants
-        (constants - Mixin::Enum.constants)
-      end
-
-      def constant_pairs
-        origin_constants.map {|name| [name, const_get(name)] }
+      def enumerated(*members, &block)
+        unite FactorFactory.create(*members, &block)
+        freeze
       end
     end
   end

data/lib/mixin/enum/accessor.rb

@@ -0,0 +1,29 @@
+module Mixin
+  module Enum
+    module Accessor
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def values
+          constant_pairs.map(&:last)
+        end
+
+        def all
+          Hash[constant_pairs]
+        end
+
+        private
+
+        def origin_constants
+          (constants - Mixin::Enum.constants)
+        end
+
+        def constant_pairs
+          origin_constants.map {|name| [name, const_get(name)] }
+        end
+      end
+    end
+  end
+end

data/lib/mixin/enum/binder.rb

@@ -0,0 +1,17 @@
+module Mixin
+  module Enum
+    module Binder
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+
+      module ClassMethods
+        def unite(factor)
+          factor.each do |name, value|
+            const_set(name, value.freeze)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mixin/enum/factor/base.rb

@@ -0,0 +1,19 @@
+module Mixin
+  module Enum
+    module Factor
+      class Base
+        def initialize
+          @items = {}
+        end
+
+        def set(name, value)
+          @items[name] = value
+        end
+
+        def each(&block)
+          @items.each(&block)
+        end
+      end
+    end
+  end
+end

data/lib/mixin/enum/factor/object.rb

@@ -0,0 +1,8 @@
+module Mixin
+  module Enum
+    module Factor
+      class Object < Base
+      end
+    end
+  end
+end

data/lib/mixin/enum/factor/struct.rb

@@ -0,0 +1,16 @@
+module Mixin
+  module Enum
+    module Factor
+      class Struct < Base
+        def initialize(*members)
+          @struct_class = ::Struct.new(*members)
+          super()
+        end
+
+        def set(name, *values)
+          super(name, @struct_class.new(*values))
+        end
+      end
+    end
+  end
+end

data/lib/mixin/enum/factor_factory.rb

@@ -0,0 +1,17 @@
+module Mixin
+  module Enum
+    class FactorFactory
+      def self.create(*members, &block)
+        build(*members).tap do |f|
+          f.instance_eval(&block)
+        end
+      end
+
+      def self.build(*members)
+        members.empty? ? Factor::Object.new : Factor::Struct.new(*members)
+      end
+
+      private_class_method :new, :allocate, :build
+    end
+  end
+end

data/lib/mixin/enum/version.rb

@@ -1,5 +1,5 @@
 module Mixin
   module Enum
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixin-enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ryo Yoneyama (@yulii)
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-10 00:00:00.000000000 Z
+date: 2016-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,7 +99,15 @@ files:
 - bin/console
 - bin/setup
 - examples/status.rb
+- examples/status_code.rb
+- examples/status_flow.rb
 - lib/mixin/enum.rb
+- lib/mixin/enum/accessor.rb
+- lib/mixin/enum/binder.rb
+- lib/mixin/enum/factor/base.rb
+- lib/mixin/enum/factor/object.rb
+- lib/mixin/enum/factor/struct.rb
+- lib/mixin/enum/factor_factory.rb
 - lib/mixin/enum/version.rb
 - mixin-enum.gemspec
 homepage: https://github.com/yulii/mixin-enum