enums 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca648558b0ebcd1b42f7f6d587ef888c7f7f58aa
+  data.tar.gz: fa6ce8d8931379a42491296016e498ec769c4194
+SHA512:
+  metadata.gz: fdbc9303c337e5196444164cef1268a05f70252acc47163d2002c22b807dae50bb088b02e0b56f975753f5442492506a2fb37f555a49ff36b3011db1900b927a
+  data.tar.gz: 759a5706d1621c805fbfa985591cd1fbe3b832a2be191555ea1c9b44850548c906abd8b1cb8f5e01abbedecced1b3335a23a5eaf8f5b28edaed2665ce602725d

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2019-02-28
+
+* Everything is new. First release

data/LICENSE.md

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

data/Manifest.txt

@@ -0,0 +1,9 @@
+CHANGELOG.md
+LICENSE.md
+Manifest.txt
+README.md
+Rakefile
+lib/enums.rb
+lib/enums/version.rb
+test/helper.rb
+test/test_enum.rb

data/README.md

@@ -0,0 +1,138 @@
+# Enums - Safe Enumeration Types
+
+enums library / gem - safe enumeration types - a set of symbolic keys bound to unique integer numbers
+
+* home  :: [github.com/s6ruby/enums](https://github.com/s6ruby/enums)
+* bugs  :: [github.com/s6ruby/enums/issues](https://github.com/s6ruby/enums/issues)
+* gem   :: [rubygems.org/gems/enums](https://rubygems.org/gems/enums)
+* rdoc  :: [rubydoc.info/gems/enums](http://rubydoc.info/gems/enums)
+* forum :: [wwwmake](http://groups.google.com/group/wwwmake)
+
+
+##  Why `enums` in Ruby?
+
+No library needed, just use symbols :-) or use constants. Example:
+
+``` ruby
+Color = [:red, :blue, :green]
+Color[0]  #=> :red
+Color[1]  #=> :blue
+
+# -or-
+
+Color = {red: 0, blue: 1, green: 2}
+Color[:red]   #=> 0
+Color[:blue]  #=> 1
+Color.keys    #=> [:red, :blue, :green]
+Color.values  #=> [0, 1, 2]
+
+# -or-
+
+module Color
+  RED   = 0
+  BLUE  = 1
+  GREEN = 2
+end
+Color::RED   #=> 0
+Color::BLUE  #=> 1
+Color.constants  #=> [:RED, :BLUE, :GREEN]
+# ...
+```
+
+Why? Why not? Discuss.
+
+
+## Usage
+
+``` ruby
+Enum.new( 'Color', :red, :green, :blue )
+```
+
+(auto-)builds a class and code like:
+
+``` ruby
+class Enum
+  def initialize( key, value )
+    @key   = key
+    @value = value
+  end
+end
+
+class Color < Enum
+
+  RED   = new(:red,   0)
+  BLUE  = new(:blue,  1)
+  GREEN = new(:green, 2)
+
+  def self.red()   RED; end
+  def self.blue()  BLUE; end
+  def self.green() GREEN; end
+
+  def self.values()  [0,1,2]; end
+  def self.keys()    [:red, :blue, :green]; end
+  def self.members() [RED, BLUE, GREEN]; 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 red?()   self == RED; end
+  def blue?()  self == BLUE; end
+  def green?() self == GREEN; end
+end
+
+def Color( arg )
+  Color.value( arg )
+end
+```
+
+
+Use like:
+
+``` ruby
+Color::RED           #=> <Color @key=:red, @value=0>
+Color(0)             #=> Color::RED -or- <Color @key=:red, @value=0>
+Color.zero           #=> same as Color(0)
+Color.red            #=> Color::RED
+Color.values         #=> [0, 1, 2]
+Color.keys           #=> [:red, :green, :blue]
+Color.members        #=> [RED, GREEN, BLUE]
+                     #    -or-
+                     #   [<Color @key=:red,   @value=0>,
+                     #    <Color @key=:green, @value=1>,
+                     #    <Color @key=:blue,  @value=2>]
+Color(1)             #=> Color::GREEN
+Color.value(1)       # same as Color(1)
+Color[:red]          #=> Color::RED
+Color.key(:red)      # same as Color[:red]
+color = Color.red
+color.red?           #=> true
+color == Color.red   #=> true
+color.value          #=> 0
+color.key            #=> :red
+color.blue?          #=> false
+color == Color.blue  #=> false
+color.is_a? Enum     #=> true
+color.is_a? Color    #=> true
+...
+```
+
+
+
+## License
+
+![](https://publicdomainworks.github.io/buttons/zero88x31.png)
+
+The `enums` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+Send them along to the [wwwmake forum](http://groups.google.com/group/wwwmake).
+Thanks!

data/Rakefile

@@ -0,0 +1,29 @@
+require 'hoe'
+require './lib/enums/version.rb'
+
+Hoe.spec 'enums' do
+
+  self.version = Enums::VERSION
+
+  self.summary = "enums - safe enumeration types - a set of symbolic keys bound to unique integer numbers"
+  self.description = summary
+
+  self.urls    = ['https://github.com/s6ruby/enums']
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.2.2'
+  }
+
+end

data/lib/enums.rb

@@ -0,0 +1,168 @@
+# encoding: utf-8
+
+## stdlibs
+require 'pp'
+
+
+## our own code
+require 'enums/version'    # note: let version always go first
+
+##################################
+## auto-create/builds enum class.
+##
+## Example:
+##   State = Enum.new( :fundraising, :expired_refund, :successful)
+##     auto-creates/builds:
+##
+##  class Enum
+##    def initialize( key, value )
+##      @key   = key
+##      @value = value
+##    end
+##  end
+##
+##  class State < Enum
+##
+##    FUNDRAISING    = new(:fundraising,    0)
+##    EXPIRED_REFUND = new(:expired_refund, 1)
+##    SUCCESSFUL     = new(:successful,     2)
+##
+##    def self.fundraising()    FUNDRAISING; end
+##    def self.expired_refund() EXPIRED_REFUND; end
+##    def self.successful()     SUCCESSFUL; end
+##
+##    def fundraising?()     self == FUNDRAISING; end
+##    def expired_refund?()  self == EXPIRED_REFUND; end
+##    def successful?()      self == SUCCESSFUL; end
+##  end
+##
+##  pp state = State.fundraising     #=> #<State @key=:fundraising, @value=0>
+##  pp state.fundraising?            #=> true
+##  pp state.expired_refund?         #=> false
+##  pp state.successful?             #=> false
+##  pp state = State.expired_refund  #=> #<State @key=:expired_refund, @value=1>
+##  pp state.fundraising?            #=> false
+##  pp state.expired_refund?         #=> true
+##  pp state.successful?             #=> false
+
+
+module Safe
+
+
+## base class for enum
+class Enum
+  ## return a new Enum read-only class
+
+  def initialize( key, value )
+    @key   = key
+    @value = value
+    self.freeze   ## make "immutable"
+    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
+    ## puts "#{name}.value(#{index})"
+    ## pp keys
+    ## pp values
+    members[ index ]
+  end
+
+  def self.zero
+    members[0]
+  end
+
+  def self.key( key )
+    @hash ||= Hash[ keys.zip( members ) ].freeze
+    @hash[key]
+  end
+
+  def self.[]( key )   ## convenience alias for key
+    self.key( key )
+  end
+
+  def self.values
+    @values ||= (0...keys.size).to_a.freeze
+    @values
+  end
+
+  def self.convert( arg )
+    ## todo/check: support keys too - why? why not?
+    ## e.g. Color(0), Color(1)
+    ##      Color(:red), Color(:blue) - why? why not?
+    value( arg )
+  end
+
+
+
+  ###################
+  ##  meta-programming "macro" - build class (on the fly)
+  def self.build_class( class_name, *keys )
+
+    ## 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/
+      else
+        raise ArgumentError.new( "[Enum] arguments to Enum.new must be all symbols following the ruby id naming rules; >#{key}< failed" )
+      end
+    end
+
+    klass = Class.new( Enum )
+
+    ## add self.new too - note: call/forward to "old" orginal self.new of Event (base) class
+    klass.define_singleton_method( :new ) do |*args|
+      old_new( *args )
+    end
+
+    keys.each_with_index do |key,index|
+      klass.class_eval( <<RUBY )
+        #{key.upcase} = new( :#{key}, #{index} )
+
+        def #{key}?
+          self == #{key.upcase}
+        end
+
+        def self.#{key}
+          #{key.upcase}
+        end
+RUBY
+    end
+
+    klass.class_eval( <<RUBY )
+      def self.keys
+        @keys   ||= #{keys}.freeze
+      end
+
+      def self.members
+        @members ||= [#{keys.map {|key|key.upcase}.join(',')}].freeze
+      end
+RUBY
+
+    ## note: use Safe (module) and NOT Object for namespacing
+    ##   use include Enum to make all enums and convenience converters global
+
+    ## add global convenience converter function
+    ##  e.g. State(0) is same as State.convert(0)
+    Safe.class_eval( <<RUBY )
+      def #{class_name}( arg )
+         #{class_name}.convert( arg )
+      end
+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
+  end
+end  # class Enum
+end # module Safe
+
+
+puts Enums.banner   # say hello

data/lib/enums/version.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+## note: use a (new) class Enums  (with s!! at the end) for version info
+class Enums
+
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "enums/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+  end
+
+end # class Enums

data/test/helper.rb

@@ -0,0 +1,7 @@
+## minitest setup
+
+require 'minitest/autorun'
+
+
+## our own code
+require 'enums'

data/test/test_enum.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+##
+#  to run use
+#     ruby -I ./lib -I ./test test/test_enum.rb
+
+
+require 'helper'
+
+
+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)
+
+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.fundraising.value
+pp State.fundraising.key
+pp State::FUNDRAISING.value
+pp State::FUNDRAISING.key
+
+
+pp State
+state = State.fundraising
+pp state.fundraising?
+pp state
+pp state.value
+
+
+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]
+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
+end
+
+end # class TestEnum

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: enums
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: enums - safe enumeration types - a set of symbolic keys bound to unique
+  integer numbers
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- LICENSE.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/enums.rb
+- lib/enums/version.rb
+- test/helper.rb
+- test/test_enum.rb
+homepage: https://github.com/s6ruby/enums
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: enums - safe enumeration types - a set of symbolic keys bound to unique integer
+  numbers
+test_files: []