smart_attr 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3cf5b0d2587c7b36d9804217e246217bb9b2da21
+  data.tar.gz: 4d76c6482d0ca12b216ca4d5161b54763d0436f8
+SHA512:
+  metadata.gz: 7255744ece8b2cca8c2468f03e3fb0d3e8d6a1025b0ebaf32739ac576b7d69532411e5d3432c4b9de103c9860674218606f707cf0e21ce6e645bb4cca96b7c2c
+  data.tar.gz: fb3b58541df5bb16772ac0f9526f39dface701dbde7c00ef993394cbbd3eedd708090d93bd40d1d04b86cc90e04bc03c29c50e0f93c6781ca4fbe674acbc7504

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: true
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.3.0
+  - 2.3.1
+  - 2.3.2
+  - 2.3.3
+
+  # Because ActiveSupport-4.2 requires json-1.8.3, but json-1.8.3 is not compatible with ruby 2.4
+  # https://github.com/flori/json/issues/303
+  #- 2.4.0
+
+before_script:
+  - yes | sudo apt-get -y install mongodb
+  - sudo mongod --dbpath=/var/lib/mongodb &
+
+script: bundle exec rspec spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kun.liu@dji.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 kunliu
+
+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,154 @@
+# SmartAttr
+
+This gem helps you make your model's attribute smart.You can get many useful methods with only a little code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smart_attr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smart_attr
+
+## Usage
+
+### Basic Usage(Without database)
+
+'Without database' means that your model does not inherit from something like ActiveRecord::Base, and does not include something like Mongoid::Document.
+
+You can see more details in the example below:
+
+```ruby
+class Movie
+
+  include SmartAttr::Base
+
+  smart_attr :star, config: {
+    one:    { value: 1, desc: 'one star' },
+    two:    { value: 2, desc: 'two star' },
+    three:  { value: 3, desc: 'three star' },
+    four:   { value: 4, desc: 'four star' },
+    five:   { value: 5, desc: 'five star' }
+  }
+end
+
+Movie.star_config_hash
+# => { :one=>{:value=>1, :desc=>"one star"},
+#      :two=>{:value=>2, :desc=>"two star"},
+#      :three=>{:value=>3, :desc=>"three star"},
+#      :four=>{:value=>4, :desc=>"four star"},
+#      :five=>{:value=>5, :desc=>"five star"}
+#    }
+
+movie = Movie.new # => #<Movie:0x007fcc041b0490>
+
+movie.star = 1  # => 1
+movie.star_name # => :one
+movie.star_desc # => "one star"
+movie.star_one? # => true
+movie.star_two? # => false
+
+movie.star_two! # => 2
+movie.star      # => 2
+movie.star_two? # => true
+
+movie.star_config # => {:value=>2, :desc=>"two star", :key=>:two}
+```
+
+In this situation, an instance_variable is created to store the value when you set value for the attribute.
+
+For example:
+
+```ruby
+movie = Movie.new # => #<Movie:0x007fcc041b0490>
+movie.star = 3 # =>3
+
+# By run 'movie.inspect', you can see that there is an instance_variable named '@star'.
+movie.inspect # => "#<Movie:0x007fcc041b0490 @star=3>"
+```
+
+### Used With ActiveRecord
+
+It is almost the same like the basic usage when used with ActiveRecord.
+
+The only difference is that it will not create an instance_variable to store the value when you set value for the attribute.
+This is because it will store the value in the database. 
+
+For example, suppose you have a class named "Movie" with database table 'movies', then you should ensure that 'movies' have column 'star' before you use 'smart_attr :star, config: { # something }'
+
+```ruby
+class Movie
+
+  include SmartAttr::Base
+
+  smart_attr :star, config: {
+    one:    { value: 1, desc: 'one star' },
+    two:    { value: 2, desc: 'two star' },
+    three:  { value: 3, desc: 'three star' },
+    four:   { value: 4, desc: 'four star' },
+    five:   { value: 5, desc: 'five star' }
+  }
+end
+
+Movie.star_config_hash
+# => { :one=>{:value=>1, :desc=>"one star"},
+#      :two=>{:value=>2, :desc=>"two star"},
+#      :three=>{:value=>3, :desc=>"three star"},
+#      :four=>{:value=>4, :desc=>"four star"},
+#      :five=>{:value=>5, :desc=>"five star"}
+#    }
+
+movie = Movie.new # => #<Movie:0x007fcc041b0490>
+
+movie.star = 1  # => 1
+movie.star_name # => :one
+movie.star_desc # => "one star"
+movie.star_one? # => true
+movie.star_two? # => false
+
+movie.star_two! # => 2
+movie.star      # => 2
+movie.star_two? # => true
+
+movie.star_config # => {:value=>2, :desc=>"two star", :key=>:two}
+```
+
+### Used With Mongoid
+
+Same like used with ActiveRecord.
+
+
+## Supported Ruby Version
+From 2.0.0 To 2.3.3
+
+NOTE: 2.4.0 is not supported yet!
+
+## Status
+[![Build Status](https://travis-ci.org/liukgg/smart_attr.png)](https://travis-ci.org/liukgg/smart_attr)
+
+## TODO
+- Introduce SimpleCov
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/liukgg/smart_attr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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 "smart_attr"
+
+# 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,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/lib/smart_attr/base.rb

@@ -0,0 +1,113 @@
+require 'active_support/all'
+require 'smart_attr/config_hash'
+
+module SmartAttr
+  module Base
+
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def smart_attr *args
+        column_name, options = args[0], args.extract_options!
+
+        config = ConfigHash.new(options[:config])
+
+        # result:
+        # {
+        #   one:    { value: 1, desc: 'one star' },
+        #   two:    { value: 2, desc: 'two star' },
+        #   three:  { value: 3, desc: 'three star' },
+        #   four:   { value: 4, desc: 'four star' },
+        #   five:   { value: 5, desc: 'five star' }
+        # }
+        define_singleton_method "#{column_name}_config".to_sym do |*_args|
+          config
+        end
+
+        define_singleton_method "#{column_name}_config_hash".to_sym do |*_args|
+          config.instance_variable_get :@config_hash
+        end
+
+        # result:
+        # [
+        #   ['one star', 1],
+        #   ['two star', 2],
+        #   ['three star', 3],
+        #   ['four star', 4],
+        #   ['five star', 5]
+        # ]
+        define_singleton_method "#{column_name}_array".to_sym do |*_args|
+          _selector = self.send("#{column_name}_config").dup
+
+          _selector.inject([]) do |_result, _pair|
+            _key, _config = _pair
+
+            _result << [_config[:value], _config[:desc]]
+            _result
+          end
+        end
+
+        # result:
+        #
+        # { value: 1, desc: 'one star' }
+        #
+        define_method "#{column_name}_config".to_sym do
+          return {} unless self.class.respond_to?("#{column_name}_config".to_sym)
+
+          result = self.class.send("#{column_name}_config").item(self.send(column_name.to_s))
+          result || {}
+        end
+
+        define_method "#{column_name}_desc".to_sym do
+          self.send("#{column_name}_config")[:desc]
+        end
+
+        define_method "#{column_name}_name".to_sym do
+          self.send("#{column_name}_config")[:key]
+        end
+
+        all_instance_methods = self.private_instance_methods + self.instance_methods
+        if all_instance_methods.include?(:write_attribute) && all_instance_methods.include?(:read_attribute)
+          define_method "#{column_name}_name=".to_sym do |name|
+            write_attribute(column_name, self.class.send("#{column_name}_config")[name].try(:[], :value))
+          end
+
+          config.keys.each do |_key|
+
+            define_method "#{column_name}_#{_key}!".to_sym do
+              write_attribute(column_name, self.class.send("#{column_name}_config")[_key.to_sym].try(:[], :value))
+            end
+
+            define_method "#{column_name}_#{_key}?".to_sym do
+              read_attribute(column_name) == self.class.send("#{column_name}_config")[_key.to_sym][:value]
+            end
+          end
+        else
+          attr_accessor column_name
+
+          define_method "#{column_name}_name=".to_sym do |name|
+            send("#{column_name}=", self.class.send("#{column_name}_config")[name].try(:[], :value))
+          end
+
+          config.keys.each do |_key|
+
+            define_method "#{column_name}_#{_key}!".to_sym do
+              send("#{column_name}=", self.class.send("#{column_name}_config")[_key.to_sym][:value])
+            end
+
+            define_method "#{column_name}_#{_key}?".to_sym do
+              send(column_name) == self.class.send("#{column_name}_config")[_key.to_sym][:value]
+            end
+          end
+        end
+
+      end
+    end
+  end
+end
+
+# TODO
+# Object.send :include, SmartAttr::Base
+# ActiveRecord::Base.send :include, SmartAttr::Base if Module.constants.include? :ActiveRecord
+# Mongoid::Document.send :include,  SmartAttr::Base if Module.constants.include? :Mongoid

data/lib/smart_attr/config_hash.rb

@@ -0,0 +1,34 @@
+module SmartAttr
+  class ConfigHash
+
+    attr_reader :config_values_map
+
+    def initialize(*args)
+      @config_hash = args.extract_options!
+
+      @config_values_map = {}
+
+      @config_hash.each do |_key, _config|
+        @config_values_map[_config[:value]] = _config.merge(key: _key)
+      end
+    end
+
+    def item(value)
+      @config_values_map[value]
+    end
+
+    def keys
+      @config_hash.keys
+    end
+
+    def [](key)
+      @config_hash[key]
+    end
+
+    # TODO
+    # Add spec
+    # def method_missing
+    #   # delegate to Hash
+    # end
+  end
+end

data/lib/smart_attr/version.rb

@@ -0,0 +1,3 @@
+module SmartAttr
+  VERSION = "0.1.1"
+end

data/lib/smart_attr.rb

@@ -0,0 +1,6 @@
+require "smart_attr/version"
+require "smart_attr/base"
+
+module SmartAttr
+
+end

data/smart_attr.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smart_attr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smart_attr"
+  spec.version       = SmartAttr::VERSION
+  spec.authors       = ["kunliu"]
+  spec.email         = ["kun.liu@dji.com"]
+
+  spec.summary       = %q{SmartAttr helps you make your model's attribute smart.}
+  spec.description   = %q{This gem helps you make your model's attribute smart.You can get many useful methods with only a little code.
+}
+  spec.homepage      = "https://github.com/liukgg/smart_attr"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.0"
+  spec.add_development_dependency "pry",     "~> 0.10"
+  spec.add_development_dependency "activerecord", "~> 4.2"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "mongoid", "~> 5.1"
+
+  spec.add_dependency "activesupport", "~> 4.2"
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: smart_attr
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- kunliu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: 'This gem helps you make your model''s attribute smart.You can get many
+  useful methods with only a little code.
+
+'
+email:
+- kun.liu@dji.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/smart_attr.rb
+- lib/smart_attr/base.rb
+- lib/smart_attr/config_hash.rb
+- lib/smart_attr/version.rb
+- smart_attr.gemspec
+homepage: https://github.com/liukgg/smart_attr
+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.6
+signing_key: 
+specification_version: 4
+summary: SmartAttr helps you make your model's attribute smart.
+test_files: []
+has_rdoc: