enums 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f703a80394cb87387c0efe3311aed2c59220710
-  data.tar.gz: 39b065497a6e1fb107de0819e62999fc14c14fe0
+  metadata.gz: c1fd2c8d5f02ac6908e4a728c5875e177f3b1d1e
+  data.tar.gz: cde381d80361a980cc34825a29c897d5f3a604ff
 SHA512:
-  metadata.gz: 419c10d70475ab3b6800b6895dcb7eb2422f28c4284a27811c3ec0339922268c953e0a0844bb874a4554c5193f6d5b1b4e328cca9a129e82e694be73f6b69427
-  data.tar.gz: 3379a2c0395e83430e10b862f0de84cf5f4cc1fc2aebe5cbe5fd28e1e2eaf74c5a98a3b25b285cfdccc49841d69ad00d294e6f8d83c2c55fcc50595f6ab0e00b
+  metadata.gz: '09b36ca1dd6f1918839ab56ec2a0884777bb99a57e65aaff09a97e9d962baf3392cbd3907a70356e8226c257086b005ac6133ccdc56f26b8d26699320c6a3f7e'
+  data.tar.gz: 273c1e400392057321bae3f78776ffad156a32beffa4ad661ea8135f59cb718f861795212036cb63c480f810d13c2a41ae36e87d11d7789c1ffb0d4f871f9a0d

data/README.md

@@ -45,8 +45,13 @@ Why? Why not? Discuss.
 
 ``` ruby
 Enum.new( 'Color', :red, :green, :blue )
+# or
+enum 'Color', :red, :green, :blue
+# or
+enum 'Color', [:red, :green, :blue]
 ```
 
+
 (Auto-)builds a class and code like:
 
 ``` ruby
@@ -71,14 +76,14 @@ class Color < Enum
   def self.keys()    [:red, :blue, :green]; end
   def self.members() [RED, BLUE, GREEN]; end
 
-  def self.value( index ) @members[index]; end
+  def self.value( index ) members[index]; end
   def self.zero() value(0); end
 
   def self.key( key )
     @hash ||= Hash[ keys.zip( members ) ]
     @hash[ key ]
   end
-  def self.[]( key )  self.key( key ); end
+  def self.[]( key ) self.key( key ); end
 
   def red?()   self == RED; end
   def blue?()  self == BLUE; end
@@ -100,6 +105,8 @@ Color.zero           #=> same as Color(0)
 Color.red            #=> Color::RED
 Color.values         #=> [0, 1, 2]
 Color.keys           #=> [:red, :green, :blue]
+Color.size           #=> 3
+Color.length         #=> same as Color.size
 Color.members        #=> [RED, GREEN, BLUE]
                      #    -or-
                      #   [<Color @key=:red,   @value=0>,
@@ -125,9 +132,16 @@ Let's try another example:
 
 ``` ruby
 Enum.new( 'State', :fundraising, :expired_refund, :successful )
+# or
+enum 'State', :fundraising, :expired_refund, :successful
+# or
+enum 'State', [:fundraising, :expired_refund, :successful]
+
 
 State.values  #=> [0, 1, 2]
 State.keys    #=> [:fundraising, :expired_refund, :successful]
+State.size    #=> 3
+State.length  #=> same as State.size
 
 State.members            #=> [FUNDRAISING, EXPIRED_REFUND, SUCCESSFUL]
                          #    -or-
@@ -147,6 +161,8 @@ State::FUNDRAISING.key   #=> :fundraising
 state = State.fundraising
 state.fundraising?       #=> true
 state.value              #=> 0
+state.is_a? Enum         #=> true
+state.is_a? State        #=> true
 
 State(0)                 #=> State::FUNDRAISING
 State(1)                 #=> State::EXPIRED_REFUND
@@ -172,7 +188,7 @@ and so on.
 - [Ruby Sample Contracts for the Universum Blockchain/World Computer Runtime](https://github.com/s6ruby/universum-contracts)
 
 
-## More Safe Data Structure (Array, Hash, Struct)
+## More Safe Data Structures (Array, Hash, Struct)
 
 [Safe Data Structures (Array, Hash, Struct)](https://github.com/s6ruby/safestruct) - Say goodbye to null / nil (and maybe) and the Billion-Dollar mistake. Say hello to zero and the Billon-Dollar fix.
 

data/lib/enums.rb

@@ -48,6 +48,13 @@ require 'enums/version'    # note: let version always go first
 
 module Safe
 
+## note: use ClassMethods pattern for auto-including class methods
+def self.included( klass )
+  klass.extend( ClassMethods )
+end
+module ClassMethods; end
+
+
 
 ## base class for enum
 class Enum
@@ -91,6 +98,10 @@ class Enum
     @values
   end
 
+  def self.size() keys.size; end
+  def self.length() size; end   ## alias (as is the ruby tradition)
+
+
   def self.convert( arg )
     ## todo/check: support keys too - why? why not?
     ## e.g. Color(0), Color(1)
@@ -104,6 +115,9 @@ class Enum
   ##  meta-programming "macro" - build class (on the fly)
   def self.build_class( class_name, *keys )
 
+    ## todo/fix:
+    ##  check class name MUST start with uppercase letter
+
     ## check if all keys are symbols and follow the ruby id(entifier) naming rules
     keys.each do |key|
       if key.is_a?( Symbol ) && key =~ /\A[a-z][a-zA-Z0-9_]*\z/
@@ -143,17 +157,21 @@ RUBY
       end
 RUBY
 
-    ## note: use Safe (module) and NOT Object for namespacing
-    ##   use include Enum to make all enums and convenience converters global
+    ## note: use Object for "namespacing"
+    ##   make all enums 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)
-    Safe.class_eval( <<RUBY )
+    ##       Color(0) is same as Color.convert(0)
+    Object.class_eval( <<RUBY )
       def #{class_name}( arg )
          #{class_name}.convert( arg )
       end
 RUBY
 
+    ## note: use Safe (module) and NO Object for namespacing
+    ##   use include Safe to make all enums constants and machinery global
     Safe.const_set( class_name, klass )   ## returns klass (plus sets global constant class name)
   end
 
@@ -162,6 +180,24 @@ RUBY
     alias_method :new,     :build_class    # replace original version with create
   end
 end  # class Enum
+
+
+module ClassMethods
+  def enum( class_name, *args )
+    ########################################
+    # note: lets you use:
+    #   enum 'Color', :red, :green, :blue
+    #    -or-
+    #   enum 'Color', [:red, :green, :blue]
+    if args[0].is_a?( Array )
+      keys = args[0]
+    else
+      keys = args
+    end
+
+    Enum.new( class_name, *keys )
+  end
+end # module ClassMethods
 end # module Safe
 
 

data/lib/enums/version.rb

@@ -4,7 +4,7 @@
 class Enums
 
   MAJOR = 1
-  MINOR = 0
+  MINOR = 1
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/test/test_enum.rb

@@ -13,76 +13,99 @@ class TestEnum < MiniTest::Test
    include Safe   ## make all enums (and "convenience" converters) global
 
 
-def test_state
-pp Enum.new( 'State', :fundraising, :expired_refund, :successful )
-
-
-puts "Safe.constants:"
-pp Safe.constants
-puts "Enum.constants:"
-pp Enum.constants
-puts "State.constants:"
-pp State.constants
-
-
-pp State.values
-pp State.keys
-## pp State(0)
+   ## Enum.new( 'State', :fundraising, :expired_refund, :successful )
+   enum 'State', :fundraising, :expired_refund, :successful
 
-pp State.members
-pp State.members[0].key
-pp State.members[0].value
-pp State.members[1].key
-pp State.members[1].value
+   pp State
+   pp State(0)
 
-pp State.fundraising.value
-pp State.fundraising.key
-pp State::FUNDRAISING.value
-pp State::FUNDRAISING.key
+   ## Enum.new( 'Color', :red, :green, :blue )
+   enum 'Color', :red, :green, :blue
 
+   pp Color
+   pp Color(0)
 
-pp State
-state = State.fundraising
-pp state.fundraising?
-pp state
-pp state.value
+   puts "Safe.constants:"
+   pp Safe.constants  #=> [:ClassMethods, :Enum, :State, :Color]
+   puts "Enum.constants:"
+   pp Enum.constants  #=> []
 
 
-pp State(0)
-pp State(1)
-pp State(2)
-pp State(3)
-
-pp State.zero
-pp State(0) == State.zero
-pp State(1) == State.zero
-
-pp State.value(0)
-pp State.key(:fundraising)
-pp State[:fundraising]
+def test_state
+  assert_equal [:FUNDRAISING, :EXPIRED_REFUND, :SUCCESSFUL], State.constants
+
+  assert_equal [0, 1, 2], State.values
+  assert_equal [:fundraising, :expired_refund, :successful], State.keys
+
+  assert_equal 3, State.size
+  assert_equal 3, State.length
+
+  assert_equal State.fundraising,    State::FUNDRAISING
+  assert_equal State.expired_refund, State::EXPIRED_REFUND
+  assert_equal State.successful,     State::SUCCESSFUL
+
+  pp State.members
+  assert_equal :fundraising,    State.members[0].key
+  assert_equal 0,               State.members[0].value
+  assert_equal :expired_refund, State.members[1].key
+  assert_equal 1,               State.members[1].value
+
+  assert_equal 0,               State.fundraising.value
+  assert_equal :fundraising,    State.fundraising.key
+  assert_equal 0,               State::FUNDRAISING.value
+  assert_equal :fundraising,    State::FUNDRAISING.key
+
+  pp State
+  state = State.fundraising
+  pp state
+  assert_equal true, state.fundraising?
+  assert_equal 0,    state.value
+  assert_equal true, state.is_a?( Enum  )
+  assert_equal true, state.is_a?( State )
+
+  assert_equal State.fundraising,    State(0)
+  assert_equal State.expired_refund, State(1)
+  assert_equal State.successful,     State(2)
+
+  pp State.zero
+  assert_equal true,  State(0) == State.zero
+  assert_equal false, State(1) == State.zero
+
+  assert_equal State.fundraising, State.value(0)
+  assert_equal State.fundraising, State.key(:fundraising)
+  assert_equal State.fundraising, State[:fundraising]
 end
 
+
 def test_color
-pp Enum.new( 'Color', :red, :green, :blue )
-pp Color.zero
-pp Color(0)
-pp Color.red
-pp Color.values
-pp Color.keys
-pp Color.constants
-pp Color.members
-pp Color(1)
-pp Color.value(1)
-pp Color.key(:red)
-pp Color[:red]
-color = Color.red
-pp color.red?
-pp color == Color.red
-pp color.blue?
-pp color == Color.blue
-
-pp Color::RED
-pp Color.members
+  assert_equal [0, 1, 2],             Color.values
+  assert_equal [:red, :green, :blue], Color.keys
+  assert_equal [:RED, :GREEN, :BLUE], Color.constants
+
+  assert_equal 3, Color.size
+  assert_equal 3, Color.length
+
+  pp Color.zero
+  pp Color.red
+
+  assert_equal Color.red,   Color(0)
+  assert_equal Color.green, Color(1)
+  assert_equal Color.blue,  Color(2)
+
+  pp Color.members
+  assert_equal Color.green, Color.value(1)
+  assert_equal Color.red,   Color.key(:red)
+  assert_equal Color.red,   Color[:red]
+
+  color = Color.red
+  assert_equal true,  color.red?
+  assert_equal true,  color == Color.red
+  assert_equal false, color.blue?
+  assert_equal false, color == Color.blue
+
+  assert_equal Color.red,   Color::RED
+  assert_equal Color.green, Color::GREEN
+  assert_equal Color.blue,  Color::BLUE
 end
 
 end # class TestEnum

metadata

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