symbolic_attribute 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0742c9ffef4b8619d7c3f259545c681f47d7c3e
+  data.tar.gz: 4e2f57c1bec8ed848948a44afd3cf987bebd6734
+SHA512:
+  metadata.gz: d1c3a667fe60c26af7ae69df2ded9f2169f4188141d2da31dd6eb97a7a82e6b5cd3d1eb1e3f154e616a84f0c01d653cc321baa6d9dcf7f25366bf295fc2ed3fb
+  data.tar.gz: d3cf6727f35a7809f59bca4e8809380201d66f7f391977a78a16bb021478332be436530e0989519ad5531e7ec398463cf6938a031f1e16325c52955b4b235231

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+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 symbolic_attribute.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 itkin
+
+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,64 @@
+# SymbolicAttribute
+
+Ruby on Rails ActiveRecord helper to deal with constants stored in database
+
+Add a `symoblic_attribute` method to ActiveRecord::Base, which
+- overrides the instance attribute getter to symbolize its value
+- if a `:values` option key is passed with an array as value, it defines a class attribute `attribute_name.pluralize` which stores the available attribute values and validates the inclusion of any new instance attribute value within this same array
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'symbolic_attribute'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install symbolic_attribute
+
+## Usage
+
+`symoblic_attribute(attr_name, options)`
+- `attribute_name` (String) 
+- `options` (String)
+    - `:values` (Array): list the available attribute values, will be stored in a `attribute_name.pluralize` class attribute
+    - other hash keys and values are passed to `validates attribute_name` method, usefull to set some conditional validation (refer to the example bellow)
+
+```ruby
+
+class Participation
+  symoblic_attribute :role, 
+    values: %i{buyer seller}, 
+    allow_nil: true
+end
+
+Participation.roles
+> [:buyer, :seller]
+
+participation = Participation.new
+
+participation.save
+> true
+
+participation.role = "foo"
+
+participation.save
+> false
+
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/symbolic_attribute. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## 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 "symbolic_attribute"
+
+# 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/symbolic_attribute/concern.rb

@@ -0,0 +1,31 @@
+require 'active_support/concern'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/class/attribute'
+
+module SymbolicAttribute
+  module Concern
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def symbolic_attribute(attr, opts = {})
+
+        # Getter method
+        define_method attr do
+          val = read_attribute(attr)
+          val.to_sym unless val.blank?
+        end
+
+        # Add a class method and validation if :values option key is defined
+        if opts.symbolize_keys!.key?(:values)
+          class_attr_name = attr.to_s.pluralize
+          class_attribute class_attr_name, :instance_reader => false, :instance_writer => false
+          send "#{class_attr_name}=", opts.delete(:values).map(&:to_sym)
+          validates attr, opts.merge(:inclusion => { :in => proc{|instance| instance.class.send(class_attr_name)} })
+        end
+
+      end
+    end
+  end
+end
+

data/lib/symbolic_attribute/railtie.rb

@@ -0,0 +1,7 @@
+module SymbolicAttribute
+  class Railtie < Rails::Railtie
+    initializer 'symbolic_attribute.activerecord' do
+      ActiveRecord::Base.send :include, Concern
+    end
+  end
+end

data/lib/symbolic_attribute/version.rb

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

data/lib/symbolic_attribute.rb

@@ -0,0 +1,8 @@
+require "symbolic_attribute/version"
+require "symbolic_attribute/concern"
+require 'symbolic_attribute/railtie' if defined?(Rails)
+
+module SymbolicAttribute
+
+end
+

data/symbolic_attribute.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'symbolic_attribute/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "symbolic_attribute"
+  spec.version       = SymbolicAttribute::VERSION
+  spec.authors       = ["itkin"]
+  spec.email         = ["nicolas.papon@gmail.com"]
+
+  spec.summary       = %q{RoR ActiveRecord helper to deal with constants stored in db}
+  # spec.description   = %q{RoR ActiveRecord helper to deal with constants stored in db}
+  spec.homepage      = "https://github.com/itkin/symbolic_attribute"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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_dependency "activesupport"
+  spec.add_dependency "activemodel"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: symbolic_attribute
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- itkin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-26 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: activemodel
+  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: pry
+  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: 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'
+description: 
+email:
+- nicolas.papon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/symbolic_attribute.rb
+- lib/symbolic_attribute/concern.rb
+- lib/symbolic_attribute/railtie.rb
+- lib/symbolic_attribute/version.rb
+- symbolic_attribute.gemspec
+homepage: https://github.com/itkin/symbolic_attribute
+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.1
+signing_key: 
+specification_version: 4
+summary: RoR ActiveRecord helper to deal with constants stored in db
+test_files: []