rails_attr_enum 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e50e904586e33747717a8578df7a9ba7b6ca4d9b
+  data.tar.gz: c5b49a433cf04cd9ba9008e67236d9c6c71bb9ea
+SHA512:
+  metadata.gz: 3ab5f0e629717b89d5e5b25bc62abd9d3049a37c7581c8db12657368e63f24042a04045b996610e6927ddaf6c092e84f69ea5d8bafd4c2863706abb76ce64e5c
+  data.tar.gz: 4bda9c9c484c99d659683be72a0e70e8d2797a35d0b5d0c6a4b3a38ee21619fddba73fd904aa2ee924aa1510d74668aa6235e48b4585e93746541b3919dff2fd

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jeremy Fairbank
+
+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.rdoc

@@ -0,0 +1,3 @@
+= RailsAttrEnum
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsAttrEnum'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/rails_attr_enum/attr.rb

@@ -0,0 +1,11 @@
+module RailsAttrEnum
+  ## Represent an attribute
+  class Attr
+    attr_reader :name, :enum_name
+
+    def initialize(name)
+      @name = name.to_s
+      @enum_name = @name.camelize
+    end
+  end
+end

data/lib/rails_attr_enum/entry.rb

@@ -0,0 +1,6 @@
+require 'ostruct'
+
+module RailsAttrEnum
+  ## Enum entry class
+  Entry = Struct.new(:key, :value, :label)
+end

data/lib/rails_attr_enum/entry_value.rb

@@ -0,0 +1,44 @@
+require 'ostruct'
+
+module RailsAttrEnum
+  ## Forwarding class for actual attribute value
+  EntryValue = Struct.new(:model, :attr_name, :enum) do
+    delegate :==, :===, :inspect, to: :value
+
+    def method_missing(name, *args, &block)
+      default = proc { value.send(name, *args, &block) }
+
+      if matches = /^(.*?)((\?|!)?)$/.match(name)
+        const_name = matches[1].to_s.upcase
+        if enum.const_defined?(const_name)
+          case matches[2]
+          when '?'
+            value == enum.const_get(const_name)
+          when '!'
+            self.value = enum.const_get(const_name)
+          else
+            enum.const_get(const_name)
+          end
+        else
+          default.call
+        end
+      else
+        default.call
+      end
+    end
+
+    def key
+      enum.get_key(value)
+    end
+
+    def value
+      model.read_attribute(attr_name)
+    end
+
+    private
+
+    def value=(v)
+      model.send(:write_attribute, attr_name, v)
+    end
+  end
+end

data/lib/rails_attr_enum/enum.rb

@@ -0,0 +1,53 @@
+module RailsAttrEnum
+
+  ## Enum representation
+  module Enum
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def init_enum(attr_name)
+        return if @init
+        @attr_name = attr_name
+        @entries = []
+        @init = true
+      end
+
+      def add(entry)
+        const_name = entry[:key].to_s.upcase
+        const_set(const_name, entry[:value])
+        const_set("#{const_name}_LABEL", entry[:label])
+        @entries << entry
+      end
+
+      def label_value_pairs
+        labels.zip values
+      end
+
+      def get_label(value)
+        get_from_entries(:label, value)
+      end
+
+      def get_key(value)
+        get_from_entries(:key, value)
+      end
+
+      def attr_name; @attr_name end
+      def keys;   mapped(:key) end
+      def values; mapped(:value) end
+      def labels; mapped(:label) end
+
+      private
+
+      def get_from_entries(key, value)
+        @entries.find { |hash| hash[:value] == value }.try(:[], key)
+      end
+
+      def mapped(key)
+        @entries.map { |hash| hash[key] }
+      end
+    end
+  end
+
+end

data/lib/rails_attr_enum/enum_accumulator.rb

@@ -0,0 +1,81 @@
+require 'set'
+
+module RailsAttrEnum
+
+  ## Class to build up enum values
+  class EnumAccumulator
+    attr_reader :entries, :validation_rules
+
+    def initialize
+      @entries = []
+      @validation_rules = {}
+      @values = SortedSet.new
+    end
+
+    def add(key)
+      if key.is_a?(Hash)
+        key, value = key.first
+
+        case value
+        when String
+          label = value
+          value = next_free_value
+        when Hash
+          label = value[:label] || key.to_s.titleize
+          value = value[:value] || next_free_value
+        when Numeric
+          label = key.to_s.titleize
+        end
+      else
+        value = next_free_value
+        label = key.to_s.titleize
+      end
+
+      add_entry(key, value, label)
+    end
+
+    def validates(rules = {})
+      @validation_rules = rules
+    end
+
+    private
+
+    def add_entry(key, value, label)
+      Entry.new(key, value, label).tap do |entry|
+        revalue_entries!(value)
+        @entries << entry
+        @values << value
+      end
+    end
+
+    def revalue_entries!(value)
+      @entries.each do |entry|
+        if entry.value == value
+          entry.value = next_free_value!
+        end
+      end
+    end
+
+    def next_free_value
+      counter = 0
+      value =
+        if @values.empty?
+          0
+        else
+          @values.each do |v|
+            next if v < 0
+            break if v != counter
+            counter += 1
+          end
+          counter
+        end
+
+      value
+    end
+
+    def next_free_value!
+      next_free_value.tap { |v| @values << v }
+    end
+  end
+
+end

data/lib/rails_attr_enum/version.rb

@@ -0,0 +1,3 @@
+module RailsAttrEnum
+  VERSION = '0.0.2'
+end

data/lib/rails_attr_enum.rb

@@ -0,0 +1,98 @@
+module RailsAttrEnum
+
+  autoload :Attr,            'rails_attr_enum/attr.rb'
+  autoload :Entry,           'rails_attr_enum/entry.rb'
+  autoload :EntryValue,      'rails_attr_enum/entry_value.rb'
+  autoload :Enum,            'rails_attr_enum/enum.rb'
+  autoload :EnumAccumulator, 'rails_attr_enum/enum_accumulator.rb'
+  autoload :Version,         'rails_attr_enum/version.rb'
+
+  def attr_enum(attr_name, *keys, &block)
+    if block_given?
+      add_attr_enum_through_block(attr_name, &block)
+    else
+      if keys.first.is_a?(Hash)
+        add_attr_enum_through_block(attr_name) do
+          keys.first.each { |k, v| add k => v }
+        end
+      else
+        add_attr_enum_through_block(attr_name) do
+          keys.each { |k| add k }
+        end
+      end
+    end
+
+    nil
+  end
+
+  private
+
+  def add_attr_enum(attr_name, entries, validation_rules)
+    attr = Attr.new(attr_name)
+
+    @_attr_enums ||= {}
+
+    unless column_names.include?(attr.name)
+      raise "Invalid attribute name #{attr_name_s}"
+    end
+
+    if @_attr_enums.any? { |(_, enm)| enm.attr_name == attr.name }
+      raise "Already defined enum for '#{attr_name_s}'"
+    end
+
+    @_attr_enums[attr.name.to_sym] = Module.new { include Enum }.tap do |mod|
+      mod.init_enum(attr.name)
+      entries.each(&mod.method(:add))
+      const_set(attr.enum_name, mod)
+      class_eval do
+        validates(attr.name.to_sym, validation_rules.merge(inclusion: { in: mod.values }))
+      end
+    end
+
+    add_methods(attr)
+  end
+
+  def add_attr_enum_through_block(attr_name, &block)
+    acc = EnumAccumulator.new
+    acc.instance_eval(&block)
+    add_attr_enum(attr_name, acc.entries, acc.validation_rules)
+  end
+
+  # def add_attr_display_method(attr)
+  def add_methods(attr)
+    class_eval <<-EOS, __FILE__, __LINE__ + 1
+      # Add the display method like 'display_status' for attribute 'status'
+      def display_#{attr.name}
+        value = read_attribute(:#{attr.name})
+        return '' if value.nil?
+        self.class.instance_variable_get(:@_attr_enums)[:#{attr.name}].get_label(value)
+      end
+
+      # Add method like 'status?' for attribute 'status'
+      def #{attr.name}?(key = nil)
+        if key.nil?
+          !read_attribute(:#{attr.name}).nil?
+        else
+          read_attribute(:#{attr.name}) == #{attr.enum_name}.const_get(key.to_s.upcase)
+        end
+      end
+
+      # Override the attr= method
+      def #{attr.name}=(key)
+        if key.is_a? Symbol
+          #{attr.enum_name}.const_get(key.to_s.upcase).tap do |value|
+            write_attribute(:#{attr.name}, value)
+          end
+        else
+          super
+        end
+      end
+
+      # Override the attr method
+      def #{attr.name}
+        EntryValue.new(self, :#{attr.name}, #{attr.enum_name})
+      end
+    EOS
+  end
+
+end

data/lib/tasks/rails_attr_enum_tasks.rake

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,5 @@
+class User < ActiveRecord::Base
+  extend RailsAttrEnum
+
+  attr_enum :role, :admin, :author, :editor
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "rails_attr_enum"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end