rafter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 837d1cca949cd04112977a5b052b5f2f0af63dd180d3adeb71499d61fd751ae0
+  data.tar.gz: ff0c723931f39909dba6f40d6114fe9caa197cf010dc68468c6ac9416fde3d4f
+SHA512:
+  metadata.gz: 52931b14548d76391638ead1ffd920b21fa66574501dcb9e7d6a1ff65bdda6982b7db997666e5f7f3b959321daa29cd3cd4973f5f4f0feca950fceb19d7a2d06
+  data.tar.gz: c13c5543ab690c46f8bc80b07ddcc9832147d42e23e6963cc3275aa52e7b27f4c1b6a1bd347994ba1f03f9e597de9a5a2fb7ddc03a6b364258af35b95452aa82

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+/spec/dummy/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 masakazutakewaka
+
+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,48 @@
+# Rafter
+
+This gem is a Rails plugin for [ridgepole](https://github.com/winebarrel/ridgepole), a database schema manager.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+# ...
+  gem 'rafter'
+# ...
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rafter
+
+## Usege
+Once you install the gem, it automatically does the followings for you.
+
+- apply your schema file to the test database with ridgepole before spec is run
+- update your schema file when a model is generated with Rails CLI (`rails generate model ...`)
+- apply your schema file when databases are setup with Rails tasks (`rails db:setup`, `rails db:reset`)
+
+The path to your schema file defaults to `/app_root/db/Schemafile.rb`.
+
+You can change it by setting the env variable `SCHEMA_FILE`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/masakazutakewaka/rafter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rafter"
+
+# 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(__FILE__)

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/core_ext/active_record.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record/model/model_generator'
+
+module ActiveRecord
+  module Generators
+    class ModelGenerator
+
+      undef_method :create_migration_file
+
+      def append_schema_file
+        attributes.each { |a| a.attr_options.delete(:index) if a.reference? && !a.has_index? } if options[:indexes] == false
+        append_file schema_file, schema_template(File.expand_path('../templates/schemafile.rb', __dir__)), { verbose: false }
+      end
+
+      private
+
+      def schema_template(source)
+        context = instance_eval("binding")
+        if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
+          ERB.new(::File.binread(source), trim_mode: "-", eoutvar: "@output_buffer").result(context)
+        else
+          ERB.new(::File.binread(source), nil, "-", "@output_buffer").result(context)
+        end
+      end
+
+      def schema_file
+        not_found = Proc.new { return }
+        [Rails.root.join('db', 'Schemafile.rb'), ENV['SCHEMA_FILE']].find(not_found) { |f| File.file? f }
+      end
+    end
+  end
+end

data/lib/rafter/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rafter
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load File.expand_path('../tasks/database.rake', __dir__)
+    end
+  end
+end

data/lib/rafter/schema.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Rafter
+  module Schema
+    class Error < StandardError; end
+
+    def self.apply
+      status = system "ridgepole -c config/database.yml -E #{Rails.env} -f #{schema_file} --apply"
+      raise Error.new('ridgepole failed to apply Schemafile.') if status == false
+    rescue => e
+        puts e.full_message
+        exit 1
+    end
+
+    def self.schema_file
+      not_found = Proc.new { NotFoundError.new("Schemafile was not found") }
+      [Rails.root.join('db', 'Schemafile.rb'), ENV['SCHEMA_FILE']].find(not_found) { |f| File.file? f }
+    end
+    private_class_method :schema_file
+  end
+end

data/lib/rafter/version.rb

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

data/lib/rafter.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative 'rafter/railtie'
+require_relative 'rafter/schema'
+require_relative 'core_ext/active_record'
+
+module Rafter
+end

data/lib/tasks/database.rake

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+%w(db:setup db:test:load).each { |t| Rake::Task[t].clear }
+
+namespace :db do
+  desc "setup with ridgepole"
+  task setup: [:create, "schema:ridgepole:apply", :seed]
+
+  namespace :test do
+    desc "load schema with ridgepole"
+    task load: "schema:ridgepole:apply"
+  end
+
+  namespace :schema do
+    namespace :ridgepole do
+      desc "apply ridgepole's schemafile"
+      task :apply do
+        Rafter::Schema.apply
+      end
+    end
+  end
+end

data/lib/templates/schemafile.rb

@@ -0,0 +1,21 @@
+
+create_table :<%= table_name %><%= primary_key_type %>, force: :cascade do |t|
+<% attributes.each do |attribute| -%>
+<% if attribute.password_digest? -%>
+  t.string :password_digest<%= attribute.inject_options %>
+<% elsif attribute.token? -%>
+  t.string :<%= attribute.name %><%= attribute.inject_options %>
+<% else -%>
+  t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% end -%>
+<% if options[:timestamps] %>
+  t.timestamps
+<% end -%>
+end
+<% attributes.select(&:token?).each do |attribute| -%>
+  add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>, unique: true
+<% end -%>
+<% attributes_with_index.each do |attribute| -%>
+  add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>

data/rafter.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rafter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rafter"
+  spec.version       = Rafter::VERSION
+  spec.authors       = ["Masakazu Takewaka"]
+  spec.email         = ["takewakamma@gmail.com"]
+
+  spec.summary       = "Rails plugin for integration with ridgepole."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/masakazutakewaka/rafter"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'ridgepole'
+  spec.add_dependency 'rspec-rails'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "bootsnap"
+  spec.add_development_dependency "listen"
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: rafter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masakazu Takewaka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ridgepole
+  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: rspec-rails
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: rails
+  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: bootsnap
+  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: listen
+  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: Rails plugin for integration with ridgepole.
+email:
+- takewakamma@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/core_ext/active_record.rb
+- lib/rafter.rb
+- lib/rafter/railtie.rb
+- lib/rafter/schema.rb
+- lib/rafter/version.rb
+- lib/tasks/database.rake
+- lib/templates/schemafile.rb
+- rafter.gemspec
+homepage: https://github.com/masakazutakewaka/rafter
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Rails plugin for integration with ridgepole.
+test_files: []