enumish 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd34d003bdef7eaf92786ab4e6e1bd25a1ca7cab
+  data.tar.gz: '092c70c046c113815500f169ffa669b84a225a72'
+SHA512:
+  metadata.gz: 4fe669e7dc94447fb27d92907bfc40cff10fa88baf82e97c9cb72a92efc3549dfdc217cbdf0f3d7063325578c7d35acd3dcb651d357dedb1b0a867fc7cfb1bd2
+  data.tar.gz: c5d7069c7aa3c1f67c26262559af0f9932afee34ec3a39e618f3066342ea2eda9c115071248b2fa132725e3f7bdcdc2f09db914b640a11236e58e24667d2277a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Carl Mercier
+
+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,122 @@
+# Enumish
+
+Enumish is "Enum for ActiveRecord".
+
+It gives you the ability to create Enum-like values directly in the database.
+
+## Simple Example
+
+Given a model:
+
+````ruby
+class Color < ActiveRecord
+  include Enumish
+end
+````
+
+You could do things such as:
+
+````ruby
+color = Color.blue  # gets the color blue from the database
+color.blue?         # => true
+color.red?          # => false
+color.to_s          # => "blue"
+color.to_sym        # => :blue
+color.id            # returns the ID from the database
+
+Color.not_a_color  # raises MethodNotFound
+````
+
+## A-bit-more-advanced-but-still-simple Example
+
+You can combine Enumish with any other ActiveRecord functionality or Gems. For example,
+here's a model that uses Enumish and RankedModel, as well as some custom code.
+
+````ruby
+class Color < ActiveRecord
+  include RankedModel
+  ranks :position
+  include Enumish
+
+  class << self
+    def select_options
+      Color.rank(:position).where(enabled: true).map do |s|
+        { s.human_description => s.id }
+      end
+    end
+  end
+
+  def description
+    "#{self.to_s} is a beautiful color!"
+  end
+end
+````
+
+Such a model allows you, for example, to have a relationship between two models such as:
+
+````ruby
+class Car < ActiveRecord
+  has_one :color
+end
+
+car = Car.new
+car.color = Color.blue
+car.save!
+
+car.color.blue?          # => true
+car.color.red?           # => false
+car.color == Color.blue  # => true
+car.color_id             # => Integer
+
+# NOTE: table `cars` has column `color_id` of type `integer`
+````
+
+The method `.select_options` above could be used to populate an HTML `select` element.
+The value of each element would be the `id` of the corresponding `Color` record.
+
+## Migration
+
+For each model that includes Enumish, add a column named `short` of type `string`. This
+column will be used to store the "short" representation of the record. It will also be used
+as a method name, so make sure it only contains characters that are valid in a Ruby method name.
+
+````ruby
+class CreateColors < ActiveRecord::Migration[5.0]
+  def change
+    create_table :colors do |t|
+      t.string :short, null: false   # << This!
+      t.string :long, null: false
+      t.boolean :enabled, default: true, null: false
+      t.integer :position, null: false
+
+      t.timestamps
+    end
+  end
+end
+````
+
+If you'd rather name the column something else, you can override the `enum_id` method in your
+model:
+
+````ruby
+class Color < ActiveRecord
+  include Enumish
+
+  def enum_id
+    :enum_value
+  end
+end
+````
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enumish'
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "enumish"
+
+# 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(__FILE__)

data/bin/setup

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

data/enumish.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enumish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enumish"
+  spec.version       = Enumish::VERSION
+  spec.authors       = ["Carl Mercier"]
+  spec.email         = ["foss@carlmercier.com"]
+
+  spec.summary       = %q{Enum for ActiveRecord}
+  spec.description   = %q{Create Enum-like values directly in the database for flexibility, power and supremacy.}
+  spec.homepage      = "https://www.github.com/cmer/enumish"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "temping", "~> 3.9"
+  spec.add_development_dependency "sqlite3"
+  spec.add_runtime_dependency "activesupport", "~> 5.0"
+  spec.add_runtime_dependency "activerecord", "~> 5.0"
+
+end

data/lib/enumish.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "enumish/version"
+require "active_support"
+
+module Enumish
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def method_missing(method_id, *args, &block)
+      if !method_id.to_s.match(/\?$/)
+        obj = self.where(enum_id => method_id.to_s).first
+        return obj if obj.present?
+      end
+
+      super method_id, *args, &block
+    end
+
+    def enum_id
+      :short
+    end
+  end
+
+  # Allow calls such as object.friendly? or model.attitude.friendly?
+  def method_missing(method_id, *args, &block)
+    if method_id.to_s.match(/\?$/) && args.empty? && block.nil?
+      self.send(self.class.enum_id.to_s) == method_id.to_s.sub(/\?$/, "")
+    else
+      super
+    end
+  end
+
+  def to_s
+    self.send(self.class.enum_id).to_s
+  end
+
+  def to_sym
+    self.send(self.class.enum_id).to_sym
+  end
+end

data/lib/enumish/version.rb

@@ -0,0 +1,3 @@
+module Enumish
+  VERSION = "0.9.0"
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: enumish
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Carl Mercier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: temping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Create Enum-like values directly in the database for flexibility, power
+  and supremacy.
+email:
+- foss@carlmercier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- enumish.gemspec
+- lib/enumish.rb
+- lib/enumish/version.rb
+homepage: https://www.github.com/cmer/enumish
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Enum for ActiveRecord
+test_files: []