poppy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06df0c8ad043e29c594f26c10d466b80ddce8534
+  data.tar.gz: 59760e9cee24a8117c30a7068b7c6b1e8b8a7030
+SHA512:
+  metadata.gz: 333f67966160c02e2f8652bc1076d02d0db511c1048d589c6711ffad1ea43e549df8b2bab953fe1bbaccf90190bf9798d2a20b481651a83578468c4024ec96f1
+  data.tar.gz: 66eed5dd3f49a6cd716601fea630e5aec67e327fcacc92531012972b2d53c1fc09a311fc8abf4598d179fb70ff128777589b44df8ee0ff6a2dc68dc66bc7039e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Damien Adermann
+
+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,205 @@
+#Poppy
+
+## Introduction
+Simple Polymorphic Enumerations
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'poppy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install poppy
+
+
+## Usage
+
+
+### Basic
+```ruby
+class Bread < Poppy::Enum
+  values :white, :multigrain, :gluten_free
+end
+```
+
+#### Using an enum value
+```ruby
+> bread = Bread::WHITE
+> bread 
+=> Bread::WHITE
+
+> bread.humanize
+=> White
+```
+
+
+#### Listing all enum values
+```
+> Bread.list
+=> [Bread::WHITE, BREAD::MULTIGRAIN, Bread::GLUTEN_FREE]
+
+> Bread.collection
+=> [['White', 'white'], ['Multigrain', 'multigrain'], ['Gluten free', 'gluten_free']
+```
+
+### Custom values
+Each enumeration value is able to define its own behavior. This makes our enumerations much more polymorphic. By defining classes we can decide the behavior each enumeration value has. Each value added to the enumeration will be created by instantiating the matching class 
+
+E.g. Bread::WHITE is created from the value :white. It is instantiated by the class Bread::White.
+
+If no matching class exists a class will be created before it is instantiated
+
+***Never instantiate a class directly. Enum::Value.new != Enum::VALUE***
+
+
+```ruby
+class Bread < Poppy::Enum
+  values :white, :multigrain
+
+  private
+
+  class White
+    include Poppy::Value
+    
+    def enjoyed_by_kids?
+      true
+    end
+  end
+  
+  class Multigrain
+    include Poppy::Value
+    
+    def enjoyed_by_kids?
+      false
+    end
+  end
+end
+
+white = Bread::WHITE
+multi = Bread::MULTIGRAIN
+
+puts white.enjoyed_by_kids? # true
+puts multi.enoyed_by_kids? # false
+
+```
+
+Each enumeration value is just a Poro. Each value has an interface of one method, `#humanize`. More methods can be added to build a more robust interface. If not using Poppy::Rails humanize can be omitted.
+
+`Poppy::Value` by default, defines humanize to be the demodulized class name humanized and capitalized. You are free to implement this however you would like.
+
+E.g.
+
+```ruby
+class Bread < Poppy::Enum
+  values :white, :multigrain
+
+  class White
+    def humanize
+      'Black'
+    end
+  end
+  
+  class Multigrain
+    extend Poppy::Value
+  end
+end
+
+```
+
+### Polymorphism
+
+
+By giving each Enumeration value behavior we can remove switch statements from our codebase.
+
+```ruby
+bread = Bread::WHITE
+
+case bread
+when Bread::WHITE
+  puts 'My kid will love this'
+when Bread::MULTIGRAIN
+  puts 'My kid will play bread frisbee'
+when Bread::GLUTEN_FREE
+  puts 'My kid will play bread frisbee'
+end
+
+```
+
+becomes
+
+```
+if bread.enjoyed_by_kids?
+  puts 'My kid will love this'
+else
+  puts 'My kid will play bread frisbee'
+end
+```
+
+## ActiveRecord Integration
+
+See the [Poppy Rails](#TODO) Gem for a simple integration with ActiveRecord for persistance. Enum arrays are also supported for postgreSQL databases.
+
+
+##API
+
+### Poppy::Enum
+#### .value_for
+
+```ruby
+> Bread.value_for(:white)
+=> Bread::WHITE
+```
+
+#### .values
+
+```ruby
+> Bread.list_keys
+=> [:white, :multigrain, :gluten_free]
+```
+
+#### .list
+
+```ruby
+> Bread.list
+=> [Bread::WHITE, BREAD::MULTIGRAIN, Bread::GLUTEN_FREE]
+```
+
+#### .valid?
+
+```ruby
+> Bread.valid?(Bread::WHITE)
+=> true
+```
+
+### .key_for
+
+```ruby
+> Bread.key_for(Bread::WHITE)
+=> :white
+```
+
+#### .collection
+```ruby
+> Bread.collection
+=> [['White', 'white'], ['Multigrain', 'multigrain'], ['Gluten free', 'gluten_free']
+```
+* element.first is defined by the humanized value
+
+For use with the Rails form builder
+
+### Poppy::Value
+
+#### #humanize
+```ruby
+> Bread::WHITE.humanize
+=> White 
+```
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/TODO.md

@@ -0,0 +1,6 @@
+##TODO
+
+*Setup Travis
+*Add badges
+*Add i18n support
+*Add rdoc or similar

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "poppy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/poppy.rb

@@ -0,0 +1,8 @@
+require "poppy/version"
+
+module Poppy
+  # Your code goes here...
+end
+
+require "poppy/enum"
+require "poppy/value"

data/lib/poppy/enum.rb

@@ -0,0 +1,103 @@
+require 'active_support/inflector'
+
+module Poppy
+  class Enum
+    class << self
+      def values(*values)
+        self.value_keys = values
+      end
+
+      def list_keys
+        value_keys
+      end
+
+      def list
+        value_keys.map(&method(:enum_for))
+      end
+
+      def enum_for(value_key)
+        return unless valid_value_key?(value_key)
+        const_get(value_key.to_s.upcase)
+      end
+
+      def valid?(value)
+        list.include?(value)
+      end
+
+      def key_for(value)
+        return unless valid?(value)
+        key_value_map.invert[value]
+      end
+
+      def collection
+        value_keys.map(&method(:value_key_to_collection_item))
+      end
+
+      def const_missing(name_sym)
+        name = name_sym.to_s
+        if valid_class_name?(name)
+          create_poppy_class(name)
+        elsif valid_constant_name?(name)
+          create_poppy_value(name)
+        else
+          super
+        end
+      end
+
+      private
+
+      attr_accessor :value_keys
+
+      def key_value_map
+        @key_value_map ||= Hash[value_keys.map { |key| [key, enum_for(key)] }]
+      end
+
+      def value_key_to_collection_item(value_key)
+        [enum_for(value_key).humanize, value_key.to_s]
+      end
+
+      def class_for_value(value)
+        class_string = class_for_string_value(value)
+        ActiveSupport::Inflector.constantize(class_string)
+      end
+
+      def create_poppy_class(class_name)
+        const_set(class_name, Class.new.include(Poppy::Value))
+      end
+
+      def create_poppy_value(constant_name)
+        const_set(constant_name, class_for_value(constant_name.downcase).new)
+      end
+
+      def valid_value_key?(value_key)
+        value_keys.include?(value_key)
+      end
+
+      def valid_class_name?(class_name)
+        classy?(class_name) &&
+          valid_value_key?(class_name.downcase.to_sym)
+      end
+
+      def valid_constant_name?(constant_name)
+        screaming_snake_case?(constant_name) &&
+          valid_value_key?(constant_name.downcase.to_sym)
+      end
+
+      def classy?(string)
+        ActiveSupport::Inflector.classify(string.downcase) == string
+      end
+
+      def screaming_snake_case?(string)
+        ActiveSupport::Inflector.underscore(string).upcase == string
+      end
+
+      def class_for_string_value(value)
+        "#{self.to_s}::#{value.to_s.capitalize}"
+      end
+
+      def value_keys
+        @value_keys ||= []
+      end
+    end
+  end
+end

data/lib/poppy/value.rb

@@ -0,0 +1,25 @@
+require 'active_support/inflector'
+
+module Poppy
+  module Value
+    def humanize
+      ActiveSupport::Inflector.underscore(value_name).gsub('_', ' ').capitalize
+    end
+
+    def to_s
+      name_segments = self.class.name.split('::')
+      name_segments[-1] = to_screaming_snake_case(name_segments[-1])
+      name_segments.join('::')
+    end
+
+    private
+
+    def to_screaming_snake_case(string)
+      ActiveSupport::Inflector.underscore(string).upcase
+    end
+
+    def value_name
+      ActiveSupport::Inflector.demodulize(self.class.name)
+    end
+  end
+end

data/lib/poppy/version.rb

@@ -0,0 +1,3 @@
+module Poppy
+  VERSION = "0.1.0"
+end

data/poppy.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'poppy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "poppy"
+  spec.version       = Poppy::VERSION
+  spec.authors       = ["Damien Adermann"]
+  spec.email         = ["damienadermann@gmail.com"]
+
+  spec.summary       = %q{Simple Polymorphic Enumerations}
+  spec.description   = %q{Simple polymorphic enumerations for ruby}
+  spec.homepage      = "https://bitbucket.org/damienadermann/poppy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+
+  spec.add_dependency "activesupport", "~> 4.0"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: poppy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damien Adermann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Simple polymorphic enumerations for ruby
+email:
+- damienadermann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/setup
+- lib/poppy.rb
+- lib/poppy/enum.rb
+- lib/poppy/value.rb
+- lib/poppy/version.rb
+- poppy.gemspec
+homepage: https://bitbucket.org/damienadermann/poppy
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple Polymorphic Enumerations
+test_files: []