enum_class 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0ea8d8e6d54a15a3c13af072ea7a9f82556623d
-  data.tar.gz: f42b49f63f8c8df27bc9024994bdab0cfab4e0e4
+  metadata.gz: 05d16b831418f03c47d59dca4a82f327bdcf9703
+  data.tar.gz: 89ff063b0113f4756c7dcd42a489b66da34dd8d1
 SHA512:
-  metadata.gz: 26a18e0989467083864440f46e803aee30dc1a21e2da5f6076639bfd73b35d63b6e18ced54a3ec735f58e85af0f427cb27a4f20080940444a891640cd8a20b4b
-  data.tar.gz: ec1c235732fa550ebb12a4ca80a90f407ad885ced8785017f7ea394d5242924218222adea318f4e307d10787cdbd4a4f95421e71e11eb515d48a9ab2d61cac5b
+  metadata.gz: 8c36cc19f57bc8169a2969b63ab2e903c2509097734077a89b9e3fb4943bf2c702b84c6cff76735d447aa25e6808212c37a2d6ee32d12dfd1e3be9c639a39f03
+  data.tar.gz: 41277b7d42e6b99c1f0b4b61607a683226f65f8aa229eb23bba69155c78f30034bf54227d5e377dd2650db4337cf0f7dd44a5489af67d6854b2b8e33061793ee

data/README.md

@@ -1,13 +1,18 @@
 # Enum
 
-[![Gem Version](https://badge.fury.io/rb/enum_class.svg)](https://badge.fury.io/rb/enum_class)
+[![Gem Version](https://badge.fury.io/rb/enum_class.svg)](https://rubygems.org/gems/enum_class)
 [![Build Status](https://travis-ci.org/LIQIDTechnology/enum_class.svg?branch=master)](https://travis-ci.org/LIQIDTechnology/enum_class)
 [![Coverage Status](https://coveralls.io/repos/github/LIQIDTechnology/enum_class/badge.svg?branch=master)](https://coveralls.io/github/LIQIDTechnology/enum_class?branch=master)
 [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/enum_class/)
 [![Documentation coverage](https://inch-ci.org/github/LIQIDTechnology/enum_class.svg?branch=master)](https://inch-ci.org/github/LIQIDTechnology/enum_class)
 
-This gem is an attempt to provide a lightweight (< 300 LOC) solution for __object-oriented enumerations in Ruby__. It consists in a single class (`Enum`), that can be subclassed to create enumerations and comes with no dependencies. It stemmed out from the necessity of handling reliably features like inheritance and support for instance methods on enumerated 
-objects, features that we couldn't find in other [similar](https://github.com/capnregex/enum) [gems](https://github.com/dblock/ruby-enum).
+This gem is an attempt to provide a lightweight (< 300 LOC, no dependencies) solution for __object-oriented enumerations in Ruby__. Ruby does not provide out of the box an enumerated type and the typical way of handling enumerated values is by using lists of symbols or strings. Although this is fine for simple cases, in more involved scenarios it leaves to the programmer the burden to store, validate and associate meaning and behaviour to the possible values.
+
+Other languages, such as Java, have [native support for enum types](https://docs.oracle.com/javase/tutorial/java/javaOO/enum.html), providing a way of encapsulating the meaning and behaviour of the values in an object-oriented way. 
+
+This library attempts to bring a similar functionality to Ruby. It consists of a single class (`Enum`), that can be subclassed to create enumerated types. Each class has a set of predefined instances, that represent the enumerated values. 
+
+A few [similar](https://github.com/capnregex/enum) [gems](https://github.com/dblock/ruby-enum) have been built before, inspired by a similar design, but they missed features like support for inheritance and declaring instance methods on enumerated values, so this gem attempts to bridge that gap.
 
 ## Installation
 
@@ -30,59 +35,70 @@ Or install it yourself as:
 ### Basic usage
 
 ```ruby
-class Foo < Enum
-  value :A
-  value :B
+class Weekday < Enum
+  value :MONDAY
+  value :TUESDAY
+  value :WEDNESDAY
+  value :THURSDAY
+  value :FRIDAY
+  value :SATURDAY
+  value :SUNDAY
 end
 
-Foo.inspect  # => Foo(A, B)
+Weekday.inspect  # => Weekday(MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, ...)
+
+# Instances are accessible as constants or as class methods
+Weekday::MONDAY.class  # => Weekday
+Weekday::TUESDAY.class # => Weekday
 
-# Instances are accessible as constants
-Foo::A.class # => Foo
-Foo::B.class # => Foo
-Foo::C       # => raises NameError
+Weekday.monday         # => Weekday::MONDAY
+Weekday.tuesday        # => Weekday::TUESDAY
+
+Weekday::FOO           # => raises NameError
+Weekday.foo            # => raises NameError
 
 # Enumerated values are implicitly ordered, depending on order of definition
-Foo::A == Foo::B # => false
-Foo::A < Foo::B  # => true
+Weekday::MONDAY == Weekday::TUESDAY # => false
+Weekday::MONDAY < Weekday::TUESDAY  # => true
 
-# Instances can be retrieved by key
-Foo[:a]      # => Foo::A
-Foo['a']     # => Foo::A
-Foo.for('A') # => Foo::A
-Foo.for('X') # => raises KeyError
+# Instances can be retrieved by key; keys are case-insensitive
+Weekday[:monday]      # => Weekday::MONDAY
+Weekday['monday']     # => Weekday::MONDAY
+Weekday.for('Monday') # => Weekday::MONDAY
+Weekday.for('X')      # => raises KeyError
 
-Foo.new      # => raises an error
+Weekday.new           # => raises an error
 
-# Helper methods
-Foo.a        # => Foo::A
-Foo.b        # => Foo::B
+# Inspection methods
+Weekday::MONDAY.monday?    # => true
+Weekday::TUESDAY.monday?   # => false
 
-Foo::A.a?    # => true
-Foo::A.b?    # => false
+# Enum classes implement all methods of Enumerable
+Weekday.map { |weekday| "#{weekday.key}!" } # => ['MONDAY!', 'TUESDAY!', 'WEDNESDAY!', ...]
 ```
 
 ### Creating enums with a shortcut
 
 ```ruby
-Bar = Enum.create(:a, :b, :c) # => Bar(A, B, C)
+Grade = Enum.create(:a, :b, :c, :d, :e, :f) # => Grade(A, B, C, D, E, F)
 ```
 
-### Custom initializer
+### Custom initializer and instance methods
 ```ruby
-class Foobar < Enum
-  def initialize(name)
-    @name = name
+class Color < Enum
+  def initialize(css_code)
+    @css_code = css_code
   end
 
-  attr_reader :name
+  attr_reader :css_code
 
-  value :A, 'foo'
-  value :B, 'bar'
+  value :RED,   '#ff0000'
+  value :GREEN, '#00ff00'
+  value :BLUE,  '#0000ff'
 end
 
-Foobar::A.name # => 'foo'
-Foobar::B.name # => 'bar'
+Color::RED.css_code   # => '#ff0000'
+Color::GREEN.css_code # => '#00ff00'
 ```
 
 ### Inheritance

data/enum_class.gemspec

@@ -10,6 +10,13 @@ Gem::Specification.new do |spec|
   spec.email         = ["michele@liqid.de"]
 
   spec.summary       = 'Object-oriented enumerations for Ruby'
+  spec.description   = <<-EOF
+  Provides a lightweight solution for object-oriented enumerations in Ruby in a similar ways as other languages, like Java, do.
+  It consists of a single class (Enum), that can be subclassed to create enumerated types.
+  Each class has a set of predefined instances, that represent the enumerated values.
+  Fatures like support for inheritance and declaring instance methods on enumerated values are supported as well.
+  EOF
+
   spec.homepage      = "https://github.com/LIQIDTechnology/enum_class"
   spec.license       = "MIT"
 
@@ -18,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '~> 2.0'
+
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

data/lib/enum_class/version.rb

@@ -2,5 +2,5 @@
 
 # @!visibility private
 module EnumClass
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enum_class
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Michele Piccirillo
@@ -80,7 +80,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: |2
+    Provides a lightweight solution for object-oriented enumerations in Ruby in a similar ways as other languages, like Java, do.
+    It consists of a single class (Enum), that can be subclassed to create enumerated types.
+    Each class has a set of predefined instances, that represent the enumerated values.
+    Fatures like support for inheritance and declaring instance methods on enumerated values are supported as well.
 email:
 - michele@liqid.de
 executables: []
@@ -112,9 +116,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="