katagami 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2abb58590f32be6a0ef4521c35051d91cf5af61
+  data.tar.gz: 3e7f070bdf56023f333fc4bb1924de324a4216ce
+SHA512:
+  metadata.gz: 4a219f322229f67d21f7f9d1397da135ea29c53df6076b489427b7718bb902dc35b43e2154c6787082ef2b727d9ae0819f22e95f022ff223f626b40715334054
+  data.tar.gz: f702d1a22422e03ca10c84c206c0f7a185ea59d1c7c2659e0ae0a0055fe3be66d30a511559a27ae60e31f791ad55ba56e883790aadf88f71a3e6246821fca8bb

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 hshimoyama
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shimoyama, Hiroyasu
+
+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,95 @@
+# Katagami
+
+A toolkit for building Form object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'katagami'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install katagami
+
+## Examples
+
+Katagami provides 3 way of form field definitions.
+
+- Inherits attributes from an ActiveRecord model. (`fields_for`)
+- Inherits spcific attributes from an ActiveRecord model. (`field` with a `for:` option)
+- Define a field. (`field` with a Class as a field type)
+
+### Inherits attributes from an ActiveRecord model. (`fields_for`)
+
+`fields_for` inherits model attributes as form fields and these validators (excludes `id`, `created_at` and `updated_at`.)
+
+```rb
+class User < ActiveRecord::Base
+  # User has attributes 'id', 'name', 'email', 'created_at', 'updated_at'
+  validates :name, presence: true
+end
+```
+
+```rb
+class UserForm
+  fields_for User
+end
+
+UserForm.field_names # => [:name, :email]
+UserForm.validators[:name] # => [#<ActiveRecord::Validations::PresenceValidator:0x... @attributes=[:name], @options={}>]
+```
+
+fields_for provides `only` and `excludes` options.
+
+```rb
+class UserForm
+  fields_for User, only: :name
+end
+
+UserForm.field_names # => [:name]
+```
+
+```rb
+class UserForm
+  fields_for User, excludes: :name
+end
+
+UserForm.field_names # => [:email]
+```
+
+### Inherits spcific attributes from an ActiveRecord model. (`field` with a `for:` option)
+
+syntax sugar of `fields_for` with `only` option.
+
+```rb
+class UserForm
+  field :name, :email, for: User
+end
+UserForm.field_names # => [:name, :email]
+```
+
+### Define a field. (`field` with a Class as a field type)
+
+```rb
+class UserForm
+  field :password_confirm, String
+end
+```
+
+TBD
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hshimoyama/katagami.
+
+
+## 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,81 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'yaml'
+require 'logger'
+require 'active_record'
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :db do
+  def create_database config
+    options = {:charset => 'utf8', :collation => 'utf8_unicode_ci'}
+
+    create_db = lambda do |config|
+      ActiveRecord::Base.establish_connection config.merge('database' => nil)
+      ActiveRecord::Base.connection.create_database config['database'], options
+      ActiveRecord::Base.establish_connection config
+    end
+
+    begin
+      create_db.call config
+    rescue Mysql::Error => sqlerr
+      if sqlerr.errno == 1405
+        print "#{sqlerr.error}. \nPlease provide the root password for your mysql installation\n>"
+        root_password = $stdin.gets.strip
+
+        grant_statement = <<-SQL
+          GRANT ALL PRIVILEGES ON #{config['database']}.*
+            TO '#{config['username']}'@'localhost'
+            IDENTIFIED BY '#{config['password']}' WITH GRANT OPTION;
+        SQL
+
+        create_db.call config.merge('database' => nil, 'username' => 'root', 'password' => root_password)
+      else
+        $stderr.puts sqlerr.error
+        $stderr.puts "Couldn't create database for #{config.inspect}, charset: utf8, collation: utf8_unicode_ci"
+        $stderr.puts "(if you set the charset manually, make sure you have a matching collation)" if config['charset']
+      end
+    end
+  end
+
+  task :environment do
+    DATABASE_ENV = ENV['DATABASE_ENV'] || 'development'
+    MIGRATIONS_DIR = ENV['MIGRATIONS_DIR'] || 'db/migrate'
+  end
+
+  task :configuration => :environment do
+    @config = YAML.load_file('config/database.yml')[DATABASE_ENV]
+  end
+
+  task :configure_connection => :configuration do
+    ActiveRecord::Base.establish_connection @config
+    ActiveRecord::Base.logger = Logger.new STDOUT if @config['logger']
+  end
+
+  desc 'Create the database from config/database.yml for the current DATABASE_ENV'
+  task :create => :configure_connection do
+    create_database @config
+  end
+
+  desc 'Drops the database for the current DATABASE_ENV'
+  task :drop => :configure_connection do
+    ActiveRecord::Base.connection.drop_database @config['database']
+  end
+
+  desc 'Migrate the database (options: VERSION=x, VERBOSE=false).'
+  task :migrate => :configure_connection do
+    ActiveRecord::Migration.verbose = true
+    ActiveRecord::Migrator.migrate MIGRATIONS_DIR, ENV['VERSION'] ? ENV['VERSION'].to_i : nil
+  end
+
+  desc 'Rolls the schema back to the previous version (specify steps w/ STEP=n).'
+  task :rollback => :configure_connection do
+    step = ENV['STEP'] ? ENV['STEP'].to_i : 1
+    ActiveRecord::Migrator.rollback MIGRATIONS_DIR, step
+  end
+
+  desc "Retrieves the current schema version number"
+  task :version => :configure_connection do
+    puts "Current version: #{ActiveRecord::Migrator.current_version}"
+  end
+end

data/config/database.yml

@@ -0,0 +1,7 @@
+test:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: katagami_test
+  pool: 5
+  username: root

data/db/migrate/001_create_test_form_bases.rb

@@ -0,0 +1,11 @@
+class CreateTestFormBases < ActiveRecord::Migration[ENV["RAILS_VERSION"]]
+  def change
+    puts "here"
+    create_table :test_form_bases do |t|
+      t.integer :integer_field
+      t.string :string_field
+      t.text :text_field
+      t.timestamps
+    end
+  end
+end

data/katagami.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'katagami/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "katagami"
+  spec.version       = Katagami::VERSION
+  spec.authors       = ["hshimoyama"]
+  spec.email         = ["h.shimoyama@gmail.com"]
+
+  spec.summary       = "A toolkit for building form objects."
+  spec.description   = "A toolkit for building form objects."
+  spec.homepage      = "https://github.com/hshimoyama/katagami"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "mysql2"
+  spec.add_development_dependency "activerecord"
+
+  spec.add_dependency "axiom"
+  spec.add_dependency "virtus"
+  spec.add_dependency "activesupport"
+  spec.add_dependency "activemodel"
+end

data/lib/katagami.rb

@@ -0,0 +1,17 @@
+require "active_model"
+require "virtus"
+require "katagami/version"
+require "katagami/field"
+require "katagami/validation"
+
+module Katagami
+  extend ActiveSupport::Concern
+
+  included do
+    include Virtus.model
+    include ActiveModel::Model
+
+    include Katagami::Field
+    include Katagami::Validation
+  end
+end

data/lib/katagami/field.rb

@@ -0,0 +1,84 @@
+require "axiom.rb"
+require "katagami/field/field_option_parser"
+
+module Katagami
+  module Field
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def fields_for(model, options = {})
+        model = model.to_s.constantize
+
+        attribute_names =
+          if options[:only].present?
+            options[:only]
+          else
+            options[:excludes] ||= []
+            options[:excludes].map(&:to_sym)
+            options[:excludes].concat %i[id created_at updated_at]
+
+            model.attribute_names.reject do |an|
+              options[:excludes].include?(an.to_sym)
+            end
+          end.map(&:to_sym)
+        options = options.slice!(:only, :excludes)
+
+        attribute_names.each do |attribute_name|
+          field_for_model(attribute_name.to_sym, options.merge(for: model))
+        end
+      end
+
+      def field(*args)
+        fop = FieldOptionParser.new(args)
+        if fop.type.blank? && for_model?(fop.options)
+          fop.fields.each do |f|
+            field_for_model(f, fop.options)
+          end
+        elsif fop.type.present?
+          fop.fields.each do |f|
+            attribute(f, fop.type, fop.options)
+            validates_aggregated(f) if fop.type.include?(Katagami)
+          end
+        else
+          raise ArgumentError, "field requires 'type' or 'for:' argument."
+        end
+      end
+
+      def for_model?(options)
+        options.instance_of?(Hash) && options&.keys&.include?(:for)
+      end
+
+      def field_for_model(field_name, options)
+        model = options[:for].to_s.constantize
+        options = options.slice!(:for)
+        raise ArgumentError, "Unknown attribute[#{field_name}] for [#{model}]." unless model.attribute_names.include?(field_name.to_s)
+
+        type = detect_type(model.attribute_types[field_name.to_s])
+
+        attribute(field_name, type, options)
+
+        validates_inherited(field_name, from: model)
+      end
+
+      ATTRIBUTE_TYPE_TO_TYPE = {
+        boolean: Axiom::Types::Boolean,
+        text: String,
+        datetime: ActiveSupport::TimeWithZone
+      }.freeze
+      def detect_type(attribute_type)
+        ATTRIBUTE_TYPE_TO_TYPE[attribute_type.type] ||
+          attribute_type.type.to_s.camelize.constantize
+      end
+
+      def field_names
+        attribute_set.to_a.map do |attr|
+          if validation_aggregated?(attr.name)
+            { attr.name => attr.primitive.field_names }
+          else
+            attr.name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/katagami/field/field_option_parser.rb

@@ -0,0 +1,35 @@
+module Katagami::Field
+  class FieldOptionParser
+    def initialize(args)
+      @args = args
+    end
+
+    def has_options?
+      @args[-1].instance_of?(Hash)
+    end
+
+    def options
+      return @args[-1] if has_options?
+      {}
+    end
+
+    def has_type?
+      !type.nil?
+    end
+
+    def type
+      if !has_options? && @args[-1].instance_of?(Class)
+        @args[-1]
+      elsif has_options? && @args[-2].instance_of?(Class)
+        @args[-2]
+      end
+    end
+
+    def fields
+      e = -1
+      e -= 1 if has_options?
+      e -= 1 if has_type?
+      @args[0..e]
+    end
+  end
+end

data/lib/katagami/validation.rb

@@ -0,0 +1,60 @@
+module Katagami
+  module Validation
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def validates_aggregated(field_name)
+        validate do |record|
+          field = record.send(field_name)
+          return if field.valid?
+          record.errors.add(field_name, field.errors.messages)
+        end
+        validation_aggregated_fields << field_name.to_sym
+      end
+
+      def validation_aggregated?(field_name)
+        validation_aggregated_fields.include?(field_name.to_sym)
+      end
+
+      def validation_aggregated_fields
+        @validation_aggregated_fields ||= []
+      end
+
+      def validates_inherited(field_name, from:)
+        from = from.to_s.constantize
+        from._validators[field_name].each do |validator|
+          options = validator.options.dup
+          validates_with(
+            convert_validator(validator.class),
+            options.merge(attributes: [field_name.to_sym])
+          )
+        end
+      end
+
+      def convert_validator(validator_class)
+        if validator_class.to_s.match(/\AActiveRecord::/)
+          return validator_class.to_s.gsub('ActiveRecord', 'ActiveModel').constantize
+        end
+        validator_class
+      end
+
+      def validate_fields(fields)
+        of = new(fields)
+        of.valid?
+
+        fields.each_with_object(FormResult.new(self)) do |(field_name, v), r|
+          if validation_aggregated?(field_name)
+            field = of.send(field_name)
+            r[field_name] = field.class.validate_fields(v).result
+          else
+            messages = of.errors.messages[field_name.to_sym]
+            r[field_name] = {
+              status:  messages.present? ? "invalid" : "valid",
+              message: messages.present? ? messages.join(",") : nil
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/katagami/version.rb

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

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: katagami
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hshimoyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: 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: 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: pry-byebug
+  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: mysql2
+  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: activerecord
+  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: axiom
+  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: virtus
+  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: 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'
+description: A toolkit for building form objects.
+email:
+- h.shimoyama@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/database.yml
+- db/migrate/001_create_test_form_bases.rb
+- katagami.gemspec
+- lib/katagami.rb
+- lib/katagami/field.rb
+- lib/katagami/field/field_option_parser.rb
+- lib/katagami/validation.rb
+- lib/katagami/version.rb
+homepage: https://github.com/hshimoyama/katagami
+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.5.2
+signing_key: 
+specification_version: 4
+summary: A toolkit for building form objects.
+test_files: []