pretty_validation 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a7a399de62c322c953c66ab905d303ba5e3a8ca
+  data.tar.gz: 9aff5cdff6ac4400dc7420ea60c7e6daf142f4ca
+SHA512:
+  metadata.gz: b0a7112a9f57643e6c7d1756527a94810dcb4167add692a1a4fa1f446d1bd3210b26ed5a1cbcbd616fe77a8159d5dfec0715c31cd8402772009af571caaa694f
+  data.tar.gz: 89d5650ba05f43a1991ae4241abcb1adfebc3af78b3dbaff941436e03aa5877fd92a45e0f3429aaa532a40f42c0311517e9950c2051890f27e47b100ae3515ec

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rails
+spec/log

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,19 @@
+AllCops:
+  DisplayCopNames: true
+
+Metrics/LineLength:
+  Max: 105
+
+Style/Documentation:
+  Enabled: false
+
+Lint/StringConversionInInterpolation:
+  Exclude:
+    # Refinements が文字列埋め込みで効かない
+    - 'lib/pretty_validation/validation.rb'
+
+Metrics/AbcSize:
+  Max: 17
+
+Lint/HandleExceptions:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+gemfile:
+  - gemfiles/rails_40.gemfile
+  - gemfiles/rails_41.gemfile
+  - gemfiles/rails_42.gemfile
+before_install: gem install bundler -v 1.10.6
+notifications:
+  email: false

data/Gemfile

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

data/README.md

@@ -0,0 +1,94 @@
+# PrettyValidation
+
+[![Build Status](https://travis-ci.org/sinsoku/pretty_validation.svg?branch=master)](https://travis-ci.org/sinsoku/pretty_validation)
+
+**"Make validations DRY"**
+
+You need not write validations generated by database schema.
+
+## Features
+
+1. generate validation modules from database schema to `app/validations/` directory
+1. automatically includes validation module into corresponding model
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pretty_validation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pretty_validation
+
+## Usage
+
+You can generate validation modules in two ways.
+
+- run the `db:migrate` task, and then automatically generates the modules.
+- run the `validation:generate` task
+
+Note: The module is overwritten each time the task.
+
+## Examples
+
+```ruby
+# db/migrate/20151105090101_create_users.rb
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :name, null: false
+      t.integer :age, null: false
+      t.boolean :admin
+
+      t.timestamps null: false
+    end
+    add_index :users, :name, unique: true
+  end
+end
+
+# app/validations/user_validation.rb
+module UserValidation
+  extend ActiveSupport::Concern
+
+  included do
+    validates :name, presence: true
+    validates :age, presence: true, numericality: true
+    validates_uniqueness_of :name
+  end
+end
+
+# app/models/user.rb
+class User < ActiveRecord::Base
+end
+```
+
+And run `rails console`:
+
+```ruby
+Loading development environment (Rails 4.2.4)
+irb(main):001:0> user = User.new
+=> #<User id: nil, name: nil, age: nil, admin: nil, created_at: nil, updated_at: nil>
+irb(main):002:0> user.valid?
+  User Exists (0.1ms)  SELECT  1 AS one FROM "users" WHERE "users"."name" IS NULL LIMIT 1
+=> false
+irb(main):003:0> p user.errors.full_messages
+["Name can't be blank", "Age can't be blank", "Age is not a number"]
+=> ["Name can't be blank", "Age can't be blank", "Age is not a number"]
+```
+
+## Supported versions
+
+- Ruby 2.1.x, 2.2.x
+- Rails 4+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sinsoku/pretty_validation.
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: [:rubocop, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pretty_validation'
+
+# 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/gemfiles/rails_40.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.0.0'
+
+gemspec :path => '../'

data/gemfiles/rails_41.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.1.0'
+
+gemspec :path => '../'

data/gemfiles/rails_42.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'rails', '~> 4.2.0'
+
+gemspec :path => '../'

data/lib/pretty_validation.rb

@@ -0,0 +1,3 @@
+require 'pretty_validation/railtie'
+require 'pretty_validation/validation_findable'
+require 'pretty_validation/version'

data/lib/pretty_validation/monkey/new_hash_syntax.rb

@@ -0,0 +1,7 @@
+module NewHashSyntax
+  refine Hash do
+    def to_s
+      map { |k, v| "#{k}: #{v.inspect}" }.join(', ')
+    end
+  end
+end

data/lib/pretty_validation/railtie.rb

@@ -0,0 +1,15 @@
+require 'rails'
+
+module PrettyValidation
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'pretty_validation/tasks/validation.rake'
+    end
+
+    initializer 'pretty_validation' do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.include PrettyValidation::ValidationFindable
+      end
+    end
+  end
+end

data/lib/pretty_validation/renderer.rb

@@ -0,0 +1,66 @@
+require 'pretty_validation/schema'
+require 'pretty_validation/validation'
+
+module PrettyValidation
+  class Renderer
+    attr_reader :table_name
+
+    def self.validations_path
+      Rails.root.join('app', 'validations')
+    end
+
+    def self.generate
+      FileUtils.mkdir_p validations_path unless File.directory? validations_path
+      Schema.table_names.each do |t|
+        r = new t
+        r.write! unless r.validations.empty?
+      end
+    end
+
+    def initialize(table_name)
+      @table_name = table_name
+    end
+
+    def render
+      <<-EOF
+module #{module_name}
+  extend ActiveSupport::Concern
+
+  included do
+    #{validations.join("\n    ")}
+  end
+end
+      EOF
+    end
+
+    def module_name
+      "#{table_name.classify}Validation"
+    end
+
+    def file_name
+      "#{module_name.underscore}.rb"
+    end
+
+    def file_path
+      Renderer.validations_path.join(file_name)
+    end
+
+    def write!
+      File.write(file_path, render)
+    end
+
+    def validations
+      sexy_validations + uniq_validations
+    end
+
+    private
+
+    def sexy_validations
+      Validation.sexy_validations(table_name)
+    end
+
+    def uniq_validations
+      Validation.unique_validations(table_name)
+    end
+  end
+end

data/lib/pretty_validation/schema.rb

@@ -0,0 +1,16 @@
+module PrettyValidation
+  class Schema
+    def self.table_names
+      ActiveRecord::Base.connection.tables
+        .delete_if { |t| t == ActiveRecord::SchemaMigration.table_name }
+    end
+
+    def self.columns(table_name)
+      ActiveRecord::Base.connection.columns(table_name)
+    end
+
+    def self.indexes(table_name)
+      ActiveRecord::Base.connection.indexes(table_name)
+    end
+  end
+end

data/lib/pretty_validation/tasks/validation.rake

@@ -0,0 +1,22 @@
+tasks = Rake.application.instance_variable_get '@tasks'
+original_db_dump = tasks.delete 'db:_dump'
+
+namespace :validation do
+  desc 'Generate validations from database schema'
+  task :generate do
+    require 'pretty_validation/renderer'
+    PrettyValidation::Renderer.generate
+  end
+end
+
+namespace :db do
+  task :_dump do
+    original_db_dump.invoke
+    # Allow this task to be called as many times as required. An example is the
+    # migrate:redo task, which calls other two internally that depend on this one.
+    original_db_dump.reenable
+
+    require 'pretty_validation/renderer'
+    PrettyValidation::Renderer.generate
+  end
+end

data/lib/pretty_validation/validation.rb

@@ -0,0 +1,56 @@
+require 'pretty_validation/monkey/new_hash_syntax'
+
+module PrettyValidation
+  class Validation
+    using NewHashSyntax
+
+    attr_reader :method_name, :column_name, :options
+
+    def self.sexy_validations(table_name)
+      columns = Schema.columns(table_name)
+      columns = columns.reject { |x| x.name.in? %w(id created_at updated_at) }
+
+      columns.map do |column|
+        options = {}
+        options[:presence] = true unless column.null
+        options[:numericality] = true if column.type == :integer
+
+        Validation.new('validates', column.name.to_sym, options) if options.present?
+      end.compact
+    end
+
+    def self.unique_validations(table_name)
+      Schema.indexes(table_name).select(&:unique).reverse.map do |x|
+        column_name = x.columns[0]
+        scope = x.columns[1..-1].map(&:to_sym)
+        options = if scope.size > 1
+                    { scope: scope }
+                  elsif scope.size == 1
+                    { scope: scope[0] }
+                  end
+
+        Validation.new('validates_uniqueness_of', column_name.to_sym, options)
+      end
+    end
+
+    def initialize(method_name, column_name, options = nil)
+      @method_name = method_name
+      @column_name = column_name
+      @options = options
+    end
+
+    def ==(other)
+      method_name == other.method_name &&
+        column_name == other.column_name &&
+        options == other.options
+    end
+
+    def to_s
+      if options.blank?
+        "#{method_name} #{column_name.inspect}"
+      else
+        "#{method_name} #{column_name.inspect}, #{options.to_s}"
+      end
+    end
+  end
+end

data/lib/pretty_validation/validation_findable.rb

@@ -0,0 +1,16 @@
+module PrettyValidation
+  module ValidationFindable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def inherited(kls)
+        super(kls)
+        begin
+          kls.include "#{kls}Validation".constantize if kls.superclass == ::ActiveRecord::Base
+        rescue NameError
+          # nothing
+        end
+      end
+    end
+  end
+end

data/lib/pretty_validation/version.rb

@@ -0,0 +1,3 @@
+module PrettyValidation
+  VERSION = '0.2.0'
+end

data/pretty_validation.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pretty_validation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pretty_validation'
+  spec.version       = PrettyValidation::VERSION
+  spec.authors       = ['sinsoku']
+  spec.email         = ['sinsoku.listy@gmail.com']
+
+  spec.summary       = 'PrettyValidation generate validation modules from database schema'
+  spec.description   = 'PrettyValidation generate validation modules from database schema'
+  spec.homepage      = 'https://github.com/sinsoku/pretty_validation'
+  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_dependency 'rails', '>= 4.0.0'
+
+  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 'rubocop'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: pretty_validation
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- sinsoku
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.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: rubocop
+  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: PrettyValidation generate validation modules from database schema
+email:
+- sinsoku.listy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rails_40.gemfile
+- gemfiles/rails_41.gemfile
+- gemfiles/rails_42.gemfile
+- lib/pretty_validation.rb
+- lib/pretty_validation/monkey/new_hash_syntax.rb
+- lib/pretty_validation/railtie.rb
+- lib/pretty_validation/renderer.rb
+- lib/pretty_validation/schema.rb
+- lib/pretty_validation/tasks/validation.rake
+- lib/pretty_validation/validation.rb
+- lib/pretty_validation/validation_findable.rb
+- lib/pretty_validation/version.rb
+- pretty_validation.gemspec
+homepage: https://github.com/sinsoku/pretty_validation
+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: PrettyValidation generate validation modules from database schema
+test_files: []
+has_rdoc: