lite_enum 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a50aba22ca2f57d2b36c6159995affa4d0f2a71
+  data.tar.gz: 0f321e80beb4af6fb509def84c7916dec6ad7e17
+SHA512:
+  metadata.gz: c9d6dfa0636cab799f9df14fb627e1c7476e1e4e719d9354306fc9a239eca0ea16a9d301b1a145467fd0812d629848d36c4c384d7299c3c4498797a1ecadcd6b
+  data.tar.gz: 7bb6d3ed9b585ee8144f9cf99360cdcc3ec9ed2f9853c1df6a61a9b15a02561255c32c7cbfb933df82c820bd208d49a3ed7018680574c8f3513ad030cd829d7a

data/.gitignore

@@ -0,0 +1,5 @@
+.bundle/
+log/*.log
+tmp/*
+*.gem
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+script: bundle exec rspec
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+lite_enum [![version]](http://rubygems.org/gems/lite_enum) [![build]](https://travis-ci.org/dobtco/lite_enum)
+=======
+
+A short and sweet enumerator class for usage with ActiveRecord, most likely.
+
+## Goals:
+
+- Concise
+- Readable
+- Useful for DOBT's stack
+- Plain ol' Ruby API
+- No auto-generation of predicate methods like in `ActiveRecord::Enum`
+
+## Usage
+
+```rb
+# Gemfile
+gem 'lite_enum'
+
+# app/models/foo.rb
+class Foo < ActiveRecord::Base
+  def self.sizes
+    LiteEnum.new(:small, :medium, :large)
+  end
+end
+
+Foo.sizes[1] # => :small
+Foo.sizes[:small] # => 1
+foo = Foo.new(size: Foo.sizes[:small])
+foo.size # => 1
+foo.size == Foo.sizes[:small] # => true
+```
+
+[version]: https://img.shields.io/gem/v/lite_enum.svg
+[build]: http://img.shields.io/travis/dobtco/lite_enum.svg

data/lib/lite_enum.rb

@@ -0,0 +1,63 @@
+require 'active_support/all'
+
+class LiteEnum < SimpleDelegator
+  # Public: Initialize an enum.
+  #
+  # members - the array of enum members. May contain a hash of options:
+  #           :start   - the number of first enum member. Defaults to 1.
+  #
+  # Examples
+  #
+  #   FRUITS = LiteEnum.new(:apple, :orange, :kiwi)
+  def initialize(*members)
+    super({})
+
+    # Support for explicit values
+    if members.length == 1 && members[0].is_a?(Hash)
+      return update members[0]
+    end
+
+    options = members.extract_options!
+    start = options.fetch(:start) { 1 }
+
+    update Hash[members.zip(start..members.count + start)]
+  end
+
+  # Public: Access the number/value of member.
+  #
+  # ids_or_value - number or value of member.
+  #
+  # Returns value if number was provided, and number if value was provided.
+  def [](id_or_value)
+    fetch(id_or_value) { key(id_or_value) }
+  end
+
+  # Public: Check if supplied member is valid.
+  def valid?(member)
+    has_key?(member)
+  end
+
+  # Public: Create a subset of enum, only include specified keys.
+  def only(*keys)
+    dup.tap do |d|
+      d.__getobj__.keep_if { |k| keys.include?(k) }
+    end
+  end
+
+  # Public: Create a subset of enum, preserve all items but specified ones.
+  def except(*keys)
+    dup.tap do |d|
+      d.__getobj__.delete_if { |k| keys.include?(k) }
+    end
+  end
+end
+
+begin
+  require 'simple_form'
+  require 'simple_form/version'
+rescue
+end
+
+if defined?(SimpleForm) && Gem::Version.new(SimpleForm::VERSION) >= Gem::Version.new('3.1.0')
+  require 'simple_form_monkeypatch'
+end

data/lib/simple_form_monkeypatch.rb

@@ -0,0 +1,26 @@
+module SimpleForm
+  module Inputs
+    class CollectionInput
+      def collection_with_lite_enum
+        @collection ||= begin
+          if options[:collection] &&
+             options[:collection].is_a?(LiteEnum) &&
+             (translated = translate_from_namespace(:options))
+
+            options.delete(:collection).map do |k, v|
+              if translated[k].is_a?(Hash)
+                [translated[k][:short], v, translated[k][:long]]
+              else
+                [translated[k], v]
+              end
+            end
+          else
+            collection_without_lite_enum
+          end
+        end
+      end
+
+      alias_method_chain :collection, :lite_enum
+    end
+  end
+end

data/lite_enum.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name = 'lite_enum'
+  s.version = '0.0.1'
+  s.required_ruby_version = Gem::Requirement.new('>= 2.0.0')
+  s.authors = ['Adam Becker']
+  s.summary = 'Lightweight Enum class'
+  s.email = 'adam@dobt.co'
+  s.license = 'MIT'
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- {features,spec}/*`.split("\n")
+  s.homepage = 'http://github.com/dobtco/lite_enum'
+
+  s.add_dependency 'activesupport'
+
+  s.add_development_dependency 'rspec-rails', '3.1.0'
+  s.add_development_dependency 'simple_form', '3.1.0'
+end

data/script/release

@@ -0,0 +1,38 @@
+#!/bin/sh
+# Tag and push a release.
+
+set -e
+
+# Make sure we're in the project root.
+
+cd $(dirname "$0")/..
+
+# Build a new gem archive.
+
+rm -rf lite_enum-*.gem
+gem build -q lite_enum.gemspec
+
+# Make sure we're on the master branch.
+
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+
+tag=v`ls lite_enum-*.gem | sed 's/^lite_enum-\(.*\)\.gem$/\1/'`
+
+# Make sure we haven't released this version before.
+
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+
+gem push lite_enum-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag"

data/spec/lite_enum_spec.rb

@@ -0,0 +1,61 @@
+require 'lite_enum'
+require 'rspec/core'
+
+describe LiteEnum do
+  let(:enum) { LiteEnum.new(:jake, :finn, :princess_bubblegum, :peppermint_butler) }
+
+  describe ".[]" do
+    it "looks up a number by symbol" do
+      expect(enum[:princess_bubblegum]).to eq(3)
+    end
+
+    it "looks up a symbol by number" do
+      expect(enum[2]).to eq(:finn)
+    end
+  end
+
+  describe ".valid?" do
+    it "returns true if a key exists" do
+      expect(enum.valid?(:finn)).to eq(true)
+    end
+
+    it "returns false if a key does not exist" do
+      expect(enum.valid?(:obama)).to eq(false)
+    end
+  end
+
+  describe ".only" do
+    it "returns only the values we ask for" do
+      expect(enum.only(:jake, :princess_bubblegum)).to eq({ jake: 1, princess_bubblegum: 3 })
+    end
+  end
+
+  describe ".except" do
+    it "returns everything but the values we ask to delete" do
+      expect(enum.except(:jake, :princess_bubblegum)).to eq({ finn: 2, peppermint_butler: 4 })
+    end
+  end
+
+  describe "options" do
+    describe "start" do
+      let(:zero_enum) { LiteEnum.new(:foo, :bar, start: 0) }
+
+      it "optionally takes a start option" do
+        expect(zero_enum[:foo]).to eq(0)
+        expect(zero_enum[:bar]).to eq(1)
+      end
+    end
+
+    describe "explicit values" do
+      let(:explicit_enum) do
+        LiteEnum.new(foo: 1, bar: 2, fizz: 4)
+      end
+
+      it "sets values explicitly" do
+        expect(explicit_enum[:foo]).to eq(1)
+        expect(explicit_enum[:bar]).to eq(2)
+        expect(explicit_enum[:fizz]).to eq(4)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: lite_enum
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: 
+email: adam@dobt.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- lib/lite_enum.rb
+- lib/simple_form_monkeypatch.rb
+- lite_enum.gemspec
+- script/release
+- spec/lite_enum_spec.rb
+homepage: http://github.com/dobtco/lite_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: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Lightweight Enum class
+test_files:
+- spec/lite_enum_spec.rb
+has_rdoc: