enums 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1fd2c8d5f02ac6908e4a728c5875e177f3b1d1e
-  data.tar.gz: cde381d80361a980cc34825a29c897d5f3a604ff
+  metadata.gz: fb53c7f0aba659b47bf538728d3c984e10f227c6
+  data.tar.gz: 35d975e75d3325e1ae884ed310b11bf73baed647
 SHA512:
-  metadata.gz: '09b36ca1dd6f1918839ab56ec2a0884777bb99a57e65aaff09a97e9d962baf3392cbd3907a70356e8226c257086b005ac6133ccdc56f26b8d26699320c6a3f7e'
-  data.tar.gz: 273c1e400392057321bae3f78776ffad156a32beffa4ad661ea8135f59cb718f861795212036cb63c480f810d13c2a41ae36e87d11d7789c1ffb0d4f871f9a0d
+  metadata.gz: d232ae4c94f1a115b71cd9fa172e2b5f6ba607a08a79e13624f4c0d1b69bcc1528e10824d19dc4ac37b78a98b158ca1017fdadbf493fa8ed6fd2a79279701c0d
+  data.tar.gz: 0663413b82dff6ebc503219df199f3b1755d74df81515660877d7cf58766fdd0f36b7fc466d61e6e62edba1815b978ba41342d128144066e2a443b7e0250a44c

data/README.md

@@ -44,11 +44,11 @@ Why? Why not? Discuss.
 ## Usage
 
 ``` ruby
-Enum.new( 'Color', :red, :green, :blue )
+Enum.new( :Color, :red, :green, :blue )
 # or
-enum 'Color', :red, :green, :blue
+enum :Color, :red, :green, :blue
 # or
-enum 'Color', [:red, :green, :blue]
+enum :Color, [:red, :green, :blue]
 ```
 
 
@@ -131,11 +131,11 @@ color.is_a? Color    #=> true
 Let's try another example:
 
 ``` ruby
-Enum.new( 'State', :fundraising, :expired_refund, :successful )
+Enum.new( :State, :fundraising, :expired_refund, :successful )
 # or
-enum 'State', :fundraising, :expired_refund, :successful
+enum :State, :fundraising, :expired_refund, :successful
 # or
-enum 'State', [:fundraising, :expired_refund, :successful]
+enum :State, [:fundraising, :expired_refund, :successful]
 
 
 State.values  #=> [0, 1, 2]

data/lib/enums.rb

@@ -11,7 +11,7 @@ require 'enums/version'    # note: let version always go first
 ## auto-create/builds enum class.
 ##
 ## Example:
-##   State = Enum.new( :fundraising, :expired_refund, :successful)
+##   Enum.new( :State, :fundraising, :expired_refund, :successful)
 ##     auto-creates/builds:
 ##
 ##  class Enum
@@ -46,19 +46,29 @@ require 'enums/version'    # note: let version always go first
 ##  pp state.successful?             #=> false
 
 
+
 module Safe
 
 ## note: use ClassMethods pattern for auto-including class methods
+##   note ClassMethods module is called SafeHelper
 def self.included( klass )
-  klass.extend( ClassMethods )
+  klass.extend( SafeHelper )
 end
-module ClassMethods; end
 
+module SafeHelper; end
+## note: also extends (include a helper methods to Safe itself)
+##  lets you use:
+##  module Safe
+##    enum :Color, :red, :green, :blue
+##  end
+extend SafeHelper
 
 
 ## base class for enum
 class Enum
   ## return a new Enum read-only class
+  attr_reader :key
+  attr_reader :value
 
   def initialize( key, value )
     @key   = key
@@ -67,10 +77,7 @@ class Enum
     self
   end
 
-  ## add read-only attribute readers
-  ##  just use attr_reader!!! - why? why not?
-  def key()   @key;   end
-  def value() @value; end
+
 
   def self.value( index )
     ## todo/fix: check for out-of-bound / unknown enum
@@ -80,6 +87,8 @@ class Enum
     members[ index ]
   end
 
+  def zero?() self == self.class.zero; end
+
   def self.zero
     members[0]
   end
@@ -157,14 +166,14 @@ RUBY
       end
 RUBY
 
-    ## note: use Object for "namespacing"
-    ##   make all enums convenience converters (always) global
+    ## note: use Kernel for "namespacing"
+    ##   make all enums Kernel convenience converters (always) global
     ##     including uppercase methods (e.g. State(), Color(), etc.) does NOT work otherwise (with other module includes)
 
     ## add global convenience converter function
     ##  e.g. State(0) is same as State.convert(0)
     ##       Color(0) is same as Color.convert(0)
-    Object.class_eval( <<RUBY )
+    Kernel.class_eval( <<RUBY )
       def #{class_name}( arg )
          #{class_name}.convert( arg )
       end
@@ -175,6 +184,7 @@ RUBY
     Safe.const_set( class_name, klass )   ## returns klass (plus sets global constant class name)
   end
 
+
   class << self
     alias_method :old_new, :new       # note: store "old" orginal version of new
     alias_method :new,     :build_class    # replace original version with create
@@ -182,13 +192,13 @@ RUBY
 end  # class Enum
 
 
-module ClassMethods
+module SafeHelper
   def enum( class_name, *args )
     ########################################
     # note: lets you use:
-    #   enum 'Color', :red, :green, :blue
+    #   enum :Color, :red, :green, :blue
     #    -or-
-    #   enum 'Color', [:red, :green, :blue]
+    #   enum :Color, [:red, :green, :blue]
     if args[0].is_a?( Array )
       keys = args[0]
     else
@@ -197,7 +207,7 @@ module ClassMethods
 
     Enum.new( class_name, *keys )
   end
-end # module ClassMethods
+end # module SafeHelper
 end # module Safe
 
 

data/lib/enums/version.rb

@@ -1,11 +1,12 @@
 # encoding: utf-8
 
-## note: use a (new) class Enums  (with s!! at the end) for version info
-class Enums
+## note: use a (new) module Enums  (with s!! at the end) for version info
+##   why? avoids "pollution" Enum namespace with (library) version info etc.
+module Enums
 
   MAJOR = 1
   MINOR = 1
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version
@@ -20,4 +21,4 @@ class Enums
     "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
   end
 
-end # class Enums
+end # module Enums

data/test/test_enum.rb

@@ -8,28 +8,30 @@
 require 'helper'
 
 
-class TestEnum < MiniTest::Test
+module Safe
+  ## Enum.new( 'State', :fundraising, :expired_refund, :successful )
+  enum :State, :fundraising, :expired_refund, :successful
 
-   include Safe   ## make all enums (and "convenience" converters) global
+  pp State
+  pp State(0)
 
+  puts "Safe.constants:"
+  pp Safe.constants  #=> [:SafeHelper, :Enum, :State, :Color]
+  puts "Enum.constants:"
+  pp Enum.constants  #=> []
+end
 
-   ## Enum.new( 'State', :fundraising, :expired_refund, :successful )
-   enum 'State', :fundraising, :expired_refund, :successful
 
-   pp State
-   pp State(0)
+class TestEnum < MiniTest::Test
+
+   include Safe   ## make all enums (and "convenience" converters) global
 
    ## Enum.new( 'Color', :red, :green, :blue )
-   enum 'Color', :red, :green, :blue
+   enum :Color, :red, :green, :blue
 
    pp Color
    pp Color(0)
 
-   puts "Safe.constants:"
-   pp Safe.constants  #=> [:ClassMethods, :Enum, :State, :Color]
-   puts "Enum.constants:"
-   pp Enum.constants  #=> []
-
 
 def test_state
   assert_equal [:FUNDRAISING, :EXPIRED_REFUND, :SUCCESSFUL], State.constants
@@ -71,6 +73,11 @@ def test_state
   assert_equal true,  State(0) == State.zero
   assert_equal false, State(1) == State.zero
 
+  assert_equal true,  State(0).zero?
+  assert_equal true,  State.zero.zero?
+  assert_equal false, State(1).zero?
+  assert_equal false, State(2).zero?
+
   assert_equal State.fundraising, State.value(0)
   assert_equal State.fundraising, State.key(:fundraising)
   assert_equal State.fundraising, State[:fundraising]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enums
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-07 00:00:00.000000000 Z
+date: 2019-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc