rails_upgrader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6d34a70205347c3b66eece9da6995bf7ba8acec7
+  data.tar.gz: 8a7757edb3b8a7a16eb057a2d3c0ed2f4a1422e1
+SHA512:
+  metadata.gz: b9a9f19b94233dff0f32195b32267af749421d2fad317fbaafc51c2cada2a5bac969870f0c9013cf4d5974910326a5447958d7603351a9455d9201ccb791ad9f
+  data.tar.gz: 8f773fe56912cdf4445d1870ef5f4cb1e2c04d48492ae5a276f973424c3e63d266a51010c9bc7de2237ecfcd677ad44a44f318831faa63538ce233d2afe45289

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status
+

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rails_upgrader.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ombu Labs
+
+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,45 @@
+# Rails Upgrader
+
+This gem helps you automate the migration to strong parameters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'rails_upgrader'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_upgrader
+
+## Usage
+
+`rails_upgrader COMMAND`
+
+Commands:
+
+- `go`: attempt to upgrade your models and controllers in place.
+
+- `dry-run`: write strong parameter migrations to `all_strong_params.rb`.
+
+## 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/fastruby/rails_upgrader.
+
+## 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,15 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+task :build do
+  sh "gem build rails_upgrader.gemspec"
+end
+
+task release: :build do
+  sh "git push origin master"
+  sh "gem push rails_upgrader-#{RailsUpgrader::VERSION}.gem"
+end

data/bin/console

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

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_upgrader"
+
+case ARGV[0]
+when "go"
+  RailsUpgrader::CLI.call
+when "dry-run"
+  RailsUpgrader::CLI.new.send(:upgrade_strong_params)
+else
+  puts <<-EOF
+Usage: rails_upgrader COMMAND
+
+Commands:
+  go: attempt to upgrade your models and controllers in place.
+  dry-run: write strong parameter migrations to `all_strong_params.rb`.
+EOF
+end

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/rails_upgrader.rb

@@ -0,0 +1,6 @@
+require "rails_upgrader/version"
+require "rails_upgrader/cli"
+require "rails_upgrader/strong_params"
+
+module RailsUpgrader
+end

data/lib/rails_upgrader/cli.rb

@@ -0,0 +1,79 @@
+require "rails"
+require "rails_erd"
+require "rails_erd/domain"
+
+module RailsUpgrader
+  class CLI
+    attr_reader :domain
+
+    def self.call
+      new.upgrade
+    end
+
+    def initialize
+      preload_environment
+      puts "Preloading relationships..."
+      @domain = RailsERD::Domain.generate
+    end
+
+    def upgrade
+      puts "Upgrading Rails..."
+      upgrade_strong_params!
+      puts "Rails is upgraded!"
+    end
+
+    private
+
+    def upgrade_strong_params
+      result = domain.entities.map do |entity|
+        RailsUpgrader::StrongParams.new(entity).generate_method if entity.model
+      end.join
+
+      File.open("all_strong_params.rb", "w") { |f| f.write(result) }
+    end
+
+    def upgrade_strong_params!
+      domain.entities.each do |entity|
+        next unless entity.model
+        entity_to_upgrade = RailsUpgrader::StrongParams.new(entity)
+
+        unless File.file?(entity_to_upgrade.controller_path)
+          puts "Skipping #{entity.name}"
+          next
+        end
+
+        next if entity_to_upgrade.already_upgraded?
+
+        begin
+          entity_to_upgrade.update_controller_content!
+          entity_to_upgrade.update_model_content!
+        rescue => e
+          puts e.message
+          puts e.backtrace
+          next
+        end
+      end
+    end
+
+    def preload_environment
+      begin
+        require "#{Dir.pwd}/config/environment"
+      rescue LoadError => e
+        puts "Rails application not found! If you're on "\
+             "a Rails application, please open a Github issue: "\
+             "https://github.com/ombulabs/rails_upgrader/issues"
+        abort
+      end
+
+      puts "Preloading environment..."
+      Rails.application.eager_load!
+
+      if Rails.application.respond_to?(:config) && Rails.application.config
+        rails_config = Rails.application.config
+        if rails_config.respond_to?(:eager_load_namespaces)
+          rails_config.eager_load_namespaces.each(&:eager_load!)
+        end
+      end
+    end
+  end
+end

data/lib/rails_upgrader/strong_params.rb

@@ -0,0 +1,74 @@
+require "active_model/naming"
+
+module RailsUpgrader
+  class StrongParams
+    attr_reader :entity, :param_key, :controller_path, :model_path
+    ATTR_ACCESSIBLES = /\s+attr_accessible\s+([:]\w+[,]?\s+)+/.freeze
+
+    def initialize(entity)
+      @entity = entity
+      @param_key = ActiveModel::Naming.param_key(entity.model)
+      @controller_path = "app/controllers/#{param_key}s_controller.rb"
+      @model_path = "app/models/#{param_key}.rb"
+    end
+
+    def already_upgraded?
+      controller_content.include?("def #{param_key}_params")
+    end
+
+    def update_controller_content!
+      updated_content = appended_strong_params
+
+      File.open(controller_path, 'wb') do |file|
+        file.write(updated_content)
+      end
+    end
+
+    def update_model_content!
+      updated_content = removed_attr_accessible
+
+      File.open(model_path, 'wb') do |file|
+        file.write(updated_content)
+      end
+    end
+
+    private
+
+      def appended_strong_params
+        result = controller_content
+        last_end = controller_content.rindex("end")
+        result[last_end..last_end+3] = "\n#{generate_method}end\n"
+        result
+      end
+
+      def removed_attr_accessible
+        result = model_content
+        result[ATTR_ACCESSIBLES] = "\n"
+        result
+      end
+
+      def controller_content
+        File.read(controller_path)
+      end
+
+      def model_content
+        File.read(model_path)
+      end
+
+      def generate_method
+        result = "  def #{param_key}_params\n"
+        result += "    params.require(:#{param_key})\n"
+
+        param_list = entity.attributes.reject do |attribute|
+          attribute.to_s =~ /^id$|^type$|^created_at$|^updated_at$|_token$|_count$/
+        end.map { |attribute| ":#{attribute}" }.join(", ")
+        result += "          .permit(#{param_list})\n"
+
+        if entity.model.nested_attributes_options.present?
+          result += "  # TODO: check nested attributes for: #{entity.model.nested_attributes_options.keys.join(', ')}\n"
+        end
+        result += "  end\n\n"
+        result
+      end
+  end
+end

data/lib/rails_upgrader/version.rb

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

data/rails_upgrader.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_upgrader/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_upgrader"
+  spec.version       = RailsUpgrader::VERSION
+  spec.authors       = ["Mauro Otonelli"]
+  spec.email         = ["mauro@ombulabs.com"]
+
+  spec.summary       = %q{Upgrade your Rails 3 app to Rails 4}
+  spec.description   = %q{Helps with the process of upgrading your Rails 3 app to Rails 4}
+  spec.homepage      = "https://www.fastruby.io"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+  spec.executables   = ["rails_upgrader"]
+
+  spec.add_dependency "rails-erd", "~> 1.5"
+  spec.add_dependency "rails", "~> 3.2"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry-byebug", "~> 3.4.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: rails_upgrader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mauro Otonelli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails-erd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.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'
+description: Helps with the process of upgrading your Rails 3 app to Rails 4
+email:
+- mauro@ombulabs.com
+executables:
+- rails_upgrader
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rails_upgrader
+- bin/setup
+- lib/rails_upgrader.rb
+- lib/rails_upgrader/cli.rb
+- lib/rails_upgrader/strong_params.rb
+- lib/rails_upgrader/version.rb
+- rails_upgrader.gemspec
+homepage: https://www.fastruby.io
+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.14
+signing_key: 
+specification_version: 4
+summary: Upgrade your Rails 3 app to Rails 4
+test_files: []