jiffy_enums 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 90aee4a0455ac51197e626329305913fe71b81f9
+  data.tar.gz: c7b6795f2edf1c9f203446931e9cb00cae58a09a
+SHA512:
+  metadata.gz: a109cd48b738870bcd6b6dfb2d39811e18fe551082175ef91549d79bc69b459c820ca99cba187e51904ac86e7db8c020aec671d67d04e62aeff2a03fa2849ace
+  data.tar.gz: cb93be43e463df3456f8863a2411a26b67c4f518971daed46a73d4a88b6d509f5716ca9816405bebc11d019449f62a5c376b6d81de842cb05d7eb0d9cffe004f

data/.gitignore

@@ -0,0 +1,9 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+.idea/
+

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+    
+before_install:
+  - gem install bundler
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - rbx-19mode
+
+gemfile:
+  - Gemfile
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+notifications:
+  email:
+    - ci-admins@identified.com

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    jiffy_enums (0.0.1)
+      rails (~> 3.2.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.2.8)
+      actionpack (= 3.2.8)
+      mail (~> 2.4.4)
+    actionpack (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.0)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.1.3)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.0)
+    diff-lcs (1.2.4)
+    erubis (2.7.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    journey (1.0.4)
+    json (1.7.4)
+    mail (2.4.4)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    polyglot (0.3.3)
+    rack (1.4.1)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.2.8)
+      actionmailer (= 3.2.8)
+      actionpack (= 3.2.8)
+      activerecord (= 3.2.8)
+      activeresource (= 3.2.8)
+      activesupport (= 3.2.8)
+      bundler (~> 1.0)
+      railties (= 3.2.8)
+    railties (3.2.8)
+      actionpack (= 3.2.8)
+      activesupport (= 3.2.8)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    sprockets (2.1.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.15.4)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.33)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jiffy_enums!
+  rspec (~> 2.13.0)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Identified
+
+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,61 @@
+# JiffyEnums
+
+[![Build Status](https://api.travis-ci.org/Identified/jiffy_enums.png?branch=master)](https://travis-ci.org/Identified/jiffy_enums)
+[![Code Climate](https://codeclimate.com/github/Identified/jiffy_enums.png)](https://codeclimate.com/github/Identified/jiffy_enums)
+
+Java-style enums brought over to Ruby and CoffeeScript
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jiffy_enums'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### In Ruby
+
+```ruby
+Class MyEnums < JiffyEnums
+  define :ENUM1, 'enum 1'
+  define :ENUM2, 'enum 2'
+  define :ENUM3, 'enum 3'
+end
+
+MyEnums[:ENUM1].key
+=> :ENUM1
+MyEnums[:ENUM1].value
+=> "enum 1"
+MyEnums[:ENUM1].ordinal
+=> 1
+
+MyEnums::ENUM2
+=> "enum 2"
+```
+
+### In CoffeeScript (e.g. in a Rails View)
+
+```coffeescript
+Enums = {}
+<%= MyEnums.to_coffee('Enums') %>
+
+Enums.MyEnums.get('ENUM1').key
+=> "ENUM1"
+Enums.MyEnums.get('ENUM1').value
+=> "enum 1"
+Enums.MyEnums.get('ENUM1').ordinal
+=> 1
+=>
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'JiffyEnums'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/app/assets/javascripts/jiffy_enum.js.coffee

@@ -0,0 +1,2 @@
+class window.JiffyEnum
+  constructor: (@key, @value, @ordinal) ->

data/app/assets/javascripts/jiffy_enums.js.coffee

@@ -0,0 +1,36 @@
+#= require jiffy_enum
+#= require_self
+
+class window.JiffyEnums
+  constructor: (@hash) ->
+    that = this
+    _.each(@hash, (k,v) ->
+      that[v] = k
+    )
+
+  # equavalent to [] in ruby
+  get: (key) =>
+    @hash[key]
+
+  each: (func) =>
+    _.each(@hash, func)
+
+  all: (func) =>
+    _.values(@hash)
+
+  for_value: (value) =>
+    _.find( all(), (_enum) ->
+      value == _enum.value
+    )
+
+  for_ordinal: (ordinal) =>
+    _.find( all(), (_enum) ->
+      ordinal == _enum.ordinal
+    )
+
+  all_to_hash: () =>
+    hash = {}
+    each( (_enum, key) ->
+      hash[key] = _enum.value
+    )
+    hash

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/jiffy_enums.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+require 'jiffy_enums/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'jiffy_enums'
+  s.version     = JiffyEnums::VERSION
+  s.authors     = ['Tejas Ravindra Mandke']
+  s.email       = %w(tejas@identified.com)
+  s.homepage    = 'https://github.com/Identified/jiffy_enums'
+  s.summary     = 'Easy way to add enums'
+  s.description = 'Easy way to add enums'
+
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {spec,features}/*`.split("\n")
+  s.require_paths = %w(lib)
+
+  s.add_dependency 'rails', '~> 3.2.0'
+  s.add_development_dependency 'rspec', '~> 2.13.0'
+end

data/lib/jiffy_enum.rb

@@ -0,0 +1,13 @@
+require 'jiffy_enums'
+require 'jiffy_enums/engine'
+
+class JiffyEnum
+  extend Enumerable
+  extend JiffyEnums
+  attr_reader :key, :value, :ordinal
+  def initialize(key, value, ordinal)
+    @key = key
+    @value = value
+    @ordinal = ordinal
+  end
+end

data/lib/jiffy_enums/engine.rb

@@ -0,0 +1,4 @@
+module JiffyEnums
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/jiffy_enums/version.rb

@@ -0,0 +1,3 @@
+module JiffyEnums
+  VERSION = '1.0.0'
+end

data/lib/jiffy_enums.rb

@@ -0,0 +1,69 @@
+require 'jiffy_enum'
+
+module JiffyEnums
+  # ordinals start from index 1 and NOT 0
+  def define(key, value = nil, ordinal = nil, &overrides)
+    @hash ||= {}
+    @array ||= []
+    ordinal ||= @array.size + 1
+    the_enum = self.new(key, value, ordinal )
+    @hash[key]      = the_enum
+    @hash[key.to_s] = the_enum
+    @array[ordinal - 1] = the_enum
+    define_singleton_method(key) do
+      the_enum
+    end
+    the_enum.instance_eval(&overrides) unless overrides.nil?
+  end
+
+  def [] (key)
+    @hash[key]
+  end
+
+  def each
+    @array.each do |value|
+      yield value
+    end
+  end
+
+  def select *args, &block
+    all.select *args, &block
+  end
+
+  def all
+    @array.map{|x|x}.compact
+  end
+
+  def for_value (value)
+    all.select do |enum|
+      enum.value == value
+    end.first
+  end
+
+  def for_ordinal (ordinal)
+    @array[ordinal - 1]
+  end
+
+  def all_to_hash
+    hash = {}
+    each do | value|
+      hash[value.key] = value.value
+    end
+    hash
+  end
+
+  def to_coffee(baseHashStr)
+    final_coffee = ''
+    final_variable = self.name.split('::').inject(baseHashStr) do |result,part|
+      final_coffee += "#{result}.#{part} ||= {}\n"
+      "#{result}.#{part}"
+    end
+
+    final_coffee = final_coffee + "#{final_variable} = new JiffyEnums #{
+      @array.map do |enum|
+        "#{enum.key}:new JiffyEnum(\"#{enum.key}\", \"#{enum.value}\", #{enum.ordinal})"
+      end.join(", ")
+    }\n"
+    final_coffee
+  end
+end

data/lib/tasks/jiffy_enums_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :jiffy_enums do
+#   # Task goes here
+# end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/jiffy_enums/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'