another_enum 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGY2Y2NlMzMyM2Q0YjdjYTA1MzNjMDU3MDM2MGFhMWNjMmMxNTI5MA==
+  data.tar.gz: !binary |-
+    MGE4Yzg3OWViY2I1ODJiNGQ4NTFmMmU3NzgyNjEyMDZhMWFmY2M2Zg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZWQ4OWE2OTVkNjA0NDdiYWVmZTJlYjM1Yjk1YWExOWFkMzg5YjRkMmEwMjUw
+    MjNlZmZhZWE4NGQ1MDIwZDgzZTk3ZTM5Nzc0MzM2NjI4YmE0NDU3NjZmYWYx
+    MTU0Njg2OGQwOGRjY2FkYzhiMTg3MTZlZTNiNWYyZjMwNGFkYmY=
+  data.tar.gz: !binary |-
+    YTA2M2NlM2ExOWZmMTVlZmM3NjllOTkwYzMyYmZlNTZhZGY4NmU5ZDdjNzg0
+    ZmU5MjIxNjJmMmYyZmEyNmRmMTkwZTM1YjM2ZmJhNjRmYzUyNWUwOGFmMTc4
+    ODU4YjRhMmUwY2NmYzYyNTFkMTE3YjZmNzQwYjYxNGQ5NmQ4MjA=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enum_type.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Mike Williams <mdub@dogbiscuit.org>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# AnotherEnum
+
+`AnotherEnum` provides support for defining enumerated types in Ruby.  An enumerated type (or "enum") is a class with a finite (and usually small) set of predefined, named values.
+
+## Usage
+
+Define a enumerated type by subclassing AnotherEnum.  Use `.define` to define allowed values:
+
+    require 'another_enum'
+
+    class Colour < AnotherEnum
+      define :red
+      define :green
+      define :blue
+    end
+
+which become globally available:
+
+    Colour.red
+    Colour.green
+    Colour.blue
+
+Each value gets a code:
+
+    Colour.red.code     #=> "red"
+
+which can be used later to lookup the value:
+
+    Colour["red"]       #=> Colour.red
+
+It's easy to get all the defined values, or all the codes:
+
+    Colour.all          #=> [Colour.red, Colour.green, Colour.blue]
+    Colour.codes        #=> ["red", "green", "blue"]
+
+`AnotherEnum.define` takes a block, which can be used to define methods on the singleton values, e.g.
+
+    class CreditCardType < AnotherEnum
+
+      define :visa do
+
+        def surcharge
+          0.08
+        end
+
+      end
+
+      define :amex do
+
+        def surcharge
+          0.16
+        end
+
+      end
+
+    end
+
+There's even a shortcut for defining methods that return predefined values:
+
+    class CreditCardType < AnotherEnum
+
+      define :visa do
+        hardcode name: "Visa"
+        hardcode surcharge: 0.08
+      end
+
+      define :amex do
+        hardcode name: "American Express"
+        hardcode surcharge: 0.16
+      end
+
+    end
+
+## Contributing
+
+It's on GitHub. You know what to do.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+task :default => :spec
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/another_enum.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "another_enum"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Mike Williams"]
+  spec.email         = ["mdub@dogbiscuit.org"]
+  spec.summary       = %q{Support for defining enumerated types}
+  spec.homepage      = "https://github.com/mdub/another_enum"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake", "~> 10.1"
+  spec.add_development_dependency "rspec", "~> 2.14"
+
+end

data/lib/another_enum.rb

@@ -0,0 +1,125 @@
+# Provide support for defining enumerated types.
+#
+# Example
+#
+#   class Colour < AnotherEnum
+#
+#     define :red do
+#       # ...
+#     end
+#
+#     define :green do
+#       # ...
+#     end
+#
+#     define :blue do
+#       # ...
+#     end
+#
+#   end
+#
+class AnotherEnum
+
+  class << self
+
+    protected :new # prevent arbitrary new instances
+
+    # Public: Declare a enumerated value.
+    #
+    # code - a unique (String) code that identifies this value
+    # block - optional block defines behaviour specific to this value
+    #
+    # Example
+    #
+    #   class Colour < AnotherEnum; end
+    #
+    #   Colour.define :red do
+    #
+    #     def rgb
+    #       "#ff0000"
+    #     end
+    #
+    #   end
+    #
+    def define(code, &block)
+      code = code.to_sym.to_s
+      value = generate_value(code, &block)
+      register_value(code, value)
+    end
+
+    # Public: Succintly declare methods to return hardcoded values.
+    #
+    # attributes - a Hash; a method will be generated for each key, returning
+    #              the corresponding value
+    #
+    # Example
+    #
+    #   Colour.define :red do
+    #
+    #     hardcode :rgb => "#ff0000"
+    #
+    #   end
+    #
+    def hardcode(attributes)
+      attributes.each do |name, value|
+        define_method(name) { value }
+      end
+    end
+
+    def get(arg)
+      return arg if self === arg
+      @all_by_code[arg.to_s]
+    end
+
+    alias [] get
+
+    def fetch(code)
+      get(code) || raise(ArgumentError, "no such #{self}: #{code.inspect}")
+    end
+
+    def all
+      @all_by_code.values
+    end
+
+    def codes
+      @all_by_code.keys
+    end
+
+    private
+
+    def generate_value(code, &block)
+      new.tap do |value|
+        value.singleton_class.class_eval do
+          define_method(:code) { code }
+          define_method("#{code}?") { true }
+          class_eval(&block) if block
+        end
+      end
+    end
+
+    def register_value(code, value)
+      singleton_class.send(:define_method, code) { value }            # e.g. Brand.hooroo
+      class_eval "def #{code}?; false; end"                           # e.g. other_brand.hooroo?
+      @all_by_code ||= {}
+      @all_by_code[code] = value
+    end
+
+  end
+
+  def to_s
+    code
+  end
+
+  def inspect
+    "#{self.class}.#{code}"
+  end
+
+end
+
+module Kernel
+  def singleton_class
+    class << self
+      self
+    end
+  end unless respond_to?(:singleton_class)
+end

data/spec/another_enum_spec.rb

@@ -0,0 +1,71 @@
+require 'another_enum'
+
+describe AnotherEnum, :fast do
+
+  let(:direction_class) do
+    Class.new(AnotherEnum) do
+      define :north
+      define :south
+      define :east
+      define :west
+    end
+  end
+
+  describe ".define" do
+
+    it "defines a new value" do
+      direction_class.north.should be_kind_of(direction_class)
+    end
+
+    context "with a block" do
+
+      before do
+        direction_class.define :up do
+          def saying
+            "Up up and away!"
+          end
+        end
+      end
+
+      it "extends the behaviour of the specified enum value" do
+        direction_class.up.saying.should eq("Up up and away!")
+      end
+
+      it "does not affect other classes" do
+        direction_class.north.should_not respond_to(:saying)
+      end
+
+    end
+
+  end
+
+  describe ".all" do
+
+    it "returns all the defined values" do
+      direction_class.all.should eq([
+        direction_class.north,
+        direction_class.south,
+        direction_class.east,
+        direction_class.west
+      ])
+    end
+
+  end
+
+  describe ".codes" do
+
+    it "returns all the codes" do
+      direction_class.codes.should eq(%w(north south east west))
+    end
+
+  end
+
+  describe "#code" do
+
+    it "returns the value's unique code" do
+      direction_class.north.code.should eq('north')
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: another_enum
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: 
+email:
+- mdub@dogbiscuit.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- another_enum.gemspec
+- lib/another_enum.rb
+- spec/another_enum_spec.rb
+homepage: https://github.com/mdub/another_enum
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Support for defining enumerated types
+test_files:
+- spec/another_enum_spec.rb