komagire 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e351a5e68de41e09b1cdb304cdbfce54a3b1777
+  data.tar.gz: 94dcd9f96ea09b5607b0bfa5d9ab83fef37a98b7
+SHA512:
+  metadata.gz: fa4a9aae8c9ac0edb42ac19e9a8cfea252b2ba4bb892b1db18707159e4d7e9e34a60d4e515180cbb6423f27e21a731a2e1c43cf163a9f7fbd4da8f6d6c918faa
+  data.tar.gz: df54c1845237d09c47fbd82f5542f2ed5d204b65c717a4bc72e5fd846b54433400092c97541ca6407bbbccfd08854a683ebab583fa546e19a0837bf905fb9ef1

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+before_install: gem install bundler -v 1.10.5
+script:
+  - bundle install
+  - bundle exec rake spec

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 komagire.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Takumi IINO
+
+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,91 @@
+# Komagire
+
+[![Gem Version](https://badge.fury.io/rb/komagire.svg)](http://badge.fury.io/rb/komagire)
+[![Build Status](https://travis-ci.org/troter/komagire.svg?branch=master)](https://travis-ci.org/troter/komagire)
+[![Coverage Status](https://coveralls.io/repos/troter/komagire/badge.svg)](https://coveralls.io/r/troter/komagire)
+[![Code Climate](https://codeclimate.com/github/troter/komagire/badges/gpa.svg)](https://codeclimate.com/github/troter/komagire)
+
+Compose an object from comma separated keys.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'komagire'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install komagire
+
+## Usage
+
+Compose an object from `|` separated keys.
+
+```ruby
+class Tag < ActiveRecord::Base
+end
+
+Tag.create(id: 1, name: 'ruby')
+Tag.create(id: 2, name: 'perl')
+Tag.create(id: 3, name: 'java')
+
+class Post < ActiveRecord::Base
+  composed_of_komagire_key_list :tags, :tag_names, 'Tag', :name, komagire: {delimiter: '|'}
+end
+
+post = Post.new
+post.tags = 'ruby|java'
+post.tags.class # => Komagire::KeyList
+post.tags       # => [#<Tag:0x007f8fea2e46c8 id: 1, name: "ruby">,#<Tag:0x007f8fea2e44c0 id: 3, name: "java">]
+post.save
+post.tag_names  # => '|java|ruby|'
+```
+
+Compose an object from comma separated ids.
+
+```ruby
+class Post < ActiveRecord::Base
+  composed_of_komagire_id_list :tags, :tag_ids, 'Tag'
+end
+
+post = Post.new
+post.tags = '1,2'
+post.tags.class # => Komagire::IdList
+post.tags       # => [#<Tag:0x007f8fea2e46c8 id: 1, name: "ruby">,#<Tag:0x007f8fea2e44c0 id: 3, name: "java">]
+post.save
+post.tag_ids    # => ',1,2,'
+```
+
+Convertion option.
+
+```ruby
+# comma separated ids
+post.tags = '1,2'                      # string
+post.tags = %w[1 2]                    # array of string
+post.tags = [1, 2]                     # array of integer(id)
+post.tags = [Tag.find(1), Tag.find(2)] # array of Tag
+post.tags = Tag.where(id: [1, 2])      # ActiveRecord::Relation
+post.tags = Komagire::IdList.new('Tag', '1,2') # same object
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/troter/komagire. 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 "komagire"
+
+# 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/komagire.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'komagire/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "komagire"
+  spec.version       = Komagire::VERSION
+  spec.authors       = ["Takumi IINO"]
+  spec.email         = ["trot.thunder@gmail.com"]
+
+  spec.summary       = %q{Compose an object from comma separated keys.}
+  spec.description   = %q{Compose an object from comma separated keys.}
+  spec.homepage      = "https://github.com/troter/komagire"
+  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.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency "activesupport", "~> 4.0"
+  spec.add_runtime_dependency "activerecord", "~> 4.0"
+  spec.add_development_dependency "active_hash"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_development_dependency 'coveralls'
+end

data/lib/komagire.rb

@@ -0,0 +1,22 @@
+require 'komagire/version'
+require 'komagire/key_list'
+require 'komagire/id_list'
+require 'komagire/active_record_extension'
+
+module Komagire
+end
+
+begin
+  require 'rails'
+rescue LoadError
+  # ignore
+end
+
+if defined? Rails
+  require 'komagire/railtie'
+else
+  require 'active_support'
+  ActiveSupport.on_load :active_record do
+    extend Komagire::ActiveRecordExtension
+  end
+end

data/lib/komagire/active_record_extension.rb

@@ -0,0 +1,46 @@
+module Komagire
+  module ActiveRecordExtension
+    # @param [Symbol] part_id
+    # @param [Symbol] attribute
+    # @param [String] content_class_name
+    # @param [Symbol] content_class_attribute
+    # @param [Hash] options
+    # @option options [Hash] :komagire ({}) options that are passed to the Komagire::KeyList
+    def composed_of_komagire_key_list(part_id, attribute, content_class_name, content_class_attribute, options={})
+      komagire_options = options.delete(:komagire) || {}
+      options = {
+        class_name: 'Komagire::KeyList',
+        mapping: [[attribute.to_s, 'cskeys']],
+        allow_nil: false,
+        constructor: lambda { |cskeys|
+          Komagire::KeyList.new(content_class_name, content_class_attribute, cskeys, komagire_options)
+        },
+        converter: lambda { |value|
+          Komagire::KeyList.new(content_class_name, content_class_attribute, value, komagire_options)
+        },
+      }.merge(options)
+      composed_of part_id, options
+    end
+
+    # @param [Symbol] part_id
+    # @param [Symbol] attribute
+    # @param [String] content_class_name
+    # @param [Hash] options
+    # @option options [Hash] :komagire ({}) options that are passed to the Komagire::KeyList
+    def composed_of_komagire_id_list(part_id, attribute, content_class_name, options={})
+      komagire_options = options.delete(:komagire) || {}
+      options = {
+        class_name: 'Komagire::IdList',
+        mapping: [[attribute.to_s, 'csids']],
+        allow_nil: false,
+        constructor: lambda { |cskeys|
+          Komagire::IdList.new(content_class_name, cskeys, komagire_options)
+        },
+        converter: lambda { |value|
+          Komagire::IdList.new(content_class_name, value, komagire_options)
+        },
+      }.merge(options)
+      composed_of part_id, options
+    end
+  end
+end

data/lib/komagire/id_list.rb

@@ -0,0 +1,54 @@
+module Komagire
+  class IdList < KeyList
+    # @param [String] content_class_name
+    # @param [String] cskeys comma separated keys
+    # @param [Hash] options
+    # @option options [Symbol] :primary_Key
+    # @option options [String] :delimiter (Komagire::DEFAULT_DELIMITER)
+    def initialize(content_class_name, cskeys, options = {})
+      key = options.delete(:primary_key) || :id
+      super(content_class_name, key, cskeys, options)
+    end
+
+    # comma separated ids
+    #
+    # @return [String]
+    def csids
+      cskeys
+    end
+
+    private
+
+    def _convert(cskeys)
+      Converter.new(@content_class_name, @attribute, @delimiter).convert(cskeys)
+    end
+
+    def _keys
+      super.map(&:to_i)
+    end
+
+    def _find_by_cskeys
+      ancestors = content_class_name.constantize.ancestors.map(&:to_s)
+      if ancestors.include?('ActiveHash::Base')
+        _keys.map { |id| content_class_name.constantize.find_by_id(id) }.compact
+      else
+        super
+      end
+    end
+
+    class Converter < KeyList::Converter
+      def convert_to_cskeys_from_array(values)
+        case
+        when values.all? { |v| v.is_a?(String) }
+          values.join(delimiter)
+        when values.all? { |v| v.is_a?(Integer) }
+          values.join(delimiter)
+        when values.all? { |v| v.is_a?(content_class_name.constantize) }
+          values.map(&attribute).join(delimiter)
+        else
+          fail DifferentContentClass
+        end
+      end
+    end
+  end
+end

data/lib/komagire/key_list.rb

@@ -0,0 +1,100 @@
+require 'delegate'
+
+module Komagire
+  DEFAULT_DELIMITER = ','
+
+  DifferentContentClass = Class.new(StandardError)
+
+  class KeyList < SimpleDelegator
+    attr_reader :content_class_name, :attribute
+
+    # @param [String] content_class_name
+    # @param [Symbol] attribute
+    # @param [String] cskeys comma separated keys
+    # @param [Hash] options
+    # @option options [String] :delimiter (Komagire::DEFAULT_DELIMITER)
+    def initialize(content_class_name, attribute, cskeys, options = {})
+      @content_class_name = content_class_name
+      @attribute = attribute
+      @delimiter = options[:delimiter] || Komagire::DEFAULT_DELIMITER
+      @cskeys = _convert(cskeys)
+      super(_find_by_cskeys)
+    end
+
+    # comma separated keys
+    #
+    # @return [String]
+    def cskeys
+      ([''] + map(&@attribute).sort.uniq + ['']).join(@delimiter)
+    end
+
+    def freeze
+      case __getobj__
+      when ActiveRecord::Relation
+        # avoid ActiveRecord::Relation is frozen
+      else
+        super
+      end
+    end
+
+    private
+
+    def _convert(cskeys)
+      Converter.new(@content_class_name, @attribute, @delimiter).convert(cskeys)
+    end
+
+    def _keys
+      @cskeys.split(@delimiter).sort.uniq
+    end
+
+    def _find_by_cskeys
+      content_class_name.constantize.where(@attribute => _keys)
+    end
+
+    class Converter
+      attr_reader :content_class_name, :attribute, :delimiter
+
+      def initialize(content_class_name, attribute, delimiter)
+        @content_class_name = content_class_name
+        @attribute = attribute
+        @delimiter = delimiter
+      end
+
+      def convert(value)
+        convert_to_cskeys(value) || ''
+      end
+
+      def convert_to_cskeys(value)
+        case value
+        when String
+          value
+        when Komagire::KeyList
+          if value.content_class_name == content_class_name && value.attribute == attribute
+            return value.cskeys
+          end
+          fail DifferentContentClass
+        else
+          values = case
+                   when value.is_a?(Array) then value
+                   when value.respond_to?(:to_a) then value.to_a
+                   when value.respond_to?(:to_ary) then value.to_ary
+                   else
+                     fail ArgumentError
+                   end
+          convert_to_cskeys_from_array(values.compact)
+        end
+      end
+
+      def convert_to_cskeys_from_array(values)
+        case
+        when values.all? { |v| v.is_a?(String) }
+          values.join(delimiter)
+        when values.all? { |v| v.is_a?(content_class_name.constantize) }
+          values.map(&attribute).join(delimiter)
+        else
+          fail ArgumentError
+        end
+      end
+    end
+  end
+end

data/lib/komagire/railtie.rb

@@ -0,0 +1,9 @@
+module Komagire
+  class Railtie < Rails::Railtie
+    initializer 'komagire' do
+      ActiveSupport.on_load :active_record do
+        extend Komagire::ActiveRecordExtension
+      end
+    end
+  end
+end

data/lib/komagire/version.rb

@@ -0,0 +1,3 @@
+module Komagire
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: komagire
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takumi IINO
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: active_hash
+  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'
+- !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: coveralls
+  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: Compose an object from comma separated keys.
+email:
+- trot.thunder@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
+- komagire.gemspec
+- lib/komagire.rb
+- lib/komagire/active_record_extension.rb
+- lib/komagire/id_list.rb
+- lib/komagire/key_list.rb
+- lib/komagire/railtie.rb
+- lib/komagire/version.rb
+homepage: https://github.com/troter/komagire
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Compose an object from comma separated keys.
+test_files: []
+has_rdoc: