ae-be_strong 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c8215353560337f496f3af674c6776a4eb1fb91d
+  data.tar.gz: ecb9edac2ce95ded0056d327ed519a5f45fe30bb
+SHA512:
+  metadata.gz: c833a4ff3843d5fa7bdd2536698adeae0da6b74d252d1d9e72374773d522757f11e21cd8de444d5c4c90c963382a6c64b40773bfe45f365a03421754cc056d4e
+  data.tar.gz: 66c74c29941037bd85b90d894aceffc3b71858af6ff2ace49e2a58f09d094279449eecab9dbcb01837d5f37251bd2d921e889c1f41c14d2a25de648d7d4061b2

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+  - 2.3.3
+  - ruby-head
+
+before_install:
+  - gem install bundler -v 1.15.1

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 miyakey
+
+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,84 @@
+# BeStrong [![Build Status](https://travis-ci.org/appfolio/be_strong.svg?branch=appfolio)](https://travis-ci.org/appfolio/be_strong)
+
+BeStrong is a tool for converting your `attr_accessible` and `attr_protected` to **strong parameter** method.
+This is useful if you are upgrading a large Rails app.
+
++This is a bug fix fork of the original [be_strong](https://github.com/monochromegane/be_strong) gem by [monochromegane](https://github.com/monochromegane).
+
+## Examples
+
+If your code isn't strong like the following:
+
+```rb
+# Model
+class Author < ActiveRecord::Base
+  attr_accessible :name, :age
+end
+
+# Controller
+class AuthorsController < ApplicationController
+  def create
+    Author.new(params[:author])
+    ...
+  end
+end
+```
+
+After run `be_strong` command:
+
+```rb
+# Strong Model
+class Author < ActiveRecord::Base
+end
+
+# Strong Controller
+class AuthorsController < ApplicationController
+  def create
+    Author.new(author_params)
+    ...
+  end
+
+  private
+
+  def author_params
+    params.require(:author).permit(:name, :age)
+  end
+end
+```
+
+## Feature
+
+- Generate strong parameter method from model.
+- Apply strong parameter method to controller.
+- Remove `attr_accessible` method from model.
+- Remove `attr_protected` method from model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ae-be_strong'
+```
+
+## Usage
+
+```sh
+$ cd your-project
+$ bundle exec rake be_strong:convert
+```
+
+## 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](https://github.com/appfolio/be_strong).
+
+## 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/be_strong.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'be_strong/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ae-be_strong"
+  spec.version       = BeStrong::VERSION
+  spec.authors       = ["AppFolio"]
+  spec.email         = ["dev@appfolio.com"]
+
+  spec.summary       = %q{Strong parameter converter.}
+  spec.description   = %q{Strong parameter converter.}
+  spec.homepage      = "https://github.com/appfolio/be_strong"
+  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.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "protected_attributes"
+end

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "be_strong"
+
+require "pry"
+Pry.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/lib/be_strong/attr_accessible.rb

@@ -0,0 +1,23 @@
+module BeStrong
+  class AttrAccessible
+    class << self
+      def remove_all(dir)
+        files = []
+        Dir.glob(File.join(dir, '**/*.rb')).each do |file|
+          removed = remove(file)
+          files << file if removed
+        end
+        files
+      end
+
+      def remove(file)
+        buf  = File.open(file, 'r'){|f| f.read}
+        code = Code.new(buf).remove_attr_accessible_and_protected!
+        return false unless code.changed?
+
+        File.open(file, 'w'){|f| f.puts(code.to_str)}
+        true
+      end
+    end
+  end
+end

data/lib/be_strong/code.rb

@@ -0,0 +1,79 @@
+module BeStrong
+  class Code
+    include Comparable
+
+    REG_MASS_ASSIGNMENT_METHOD = /((new|build|build_.*|update|update!|assign_attributes|update_attributes|update_attributes!)([\( )])params\[:(\w*)\])/
+
+    def initialize(code)
+      @code     = code
+      @original = code.dup
+    end
+
+    def apply_strong_parameter!
+      # replace params[:model] to model_params
+      models = []
+      code.gsub!(REG_MASS_ASSIGNMENT_METHOD) do
+        if StrongParameterMethods.method_for($4)
+          models << $4
+          "#{$2}#{$3}#{$4}_params"
+        else
+          $1
+        end
+      end
+
+      return self if models.size.zero?
+
+      # add private section
+      add_private!
+
+      # add model_params method as private method
+      models.each do |model|
+        method = StrongParameterMethods.method_for(model)
+        next unless method
+
+        next if code.include?("def #{model}_params")
+
+        code.sub!(/^  private$/) do
+          "  private\n\n#{method.gsub(/^/, '  ').chomp}"
+        end
+      end
+
+      self
+    end
+
+    def add_private!
+      unless code.include?('private')
+        code.sub!(/^end/) do
+          "\n  private\nend"
+        end
+      end
+      self
+    end
+
+    def remove_attr_accessible_and_protected!
+      %w(accessible protected).each do |name|
+        code.gsub!(/( *attr_#{name}\(.*?\)$)/m, '')
+        code.gsub!(/( *attr_#{name}.+?[^,\\]$)/m, '')
+      end
+      self
+    end
+
+    def changed?
+      code != @original
+    end
+
+    def to_str
+      code
+    end
+
+    def <=>(other)
+      code <=> other
+    end
+
+    private
+
+    def code
+      @code
+    end
+  end
+end

data/lib/be_strong/converter.rb

@@ -0,0 +1,9 @@
+module BeStrong
+  class Converter
+    def self.convert(controller_path: 'app/controllers', model_path: 'app/models')
+      applied = StrongParameter.apply_all(controller_path)
+      removed = AttrAccessible.remove_all(model_path)
+      {applied: applied, removed: removed}
+    end
+  end
+end

data/lib/be_strong/rails/railtie.rb

@@ -0,0 +1,9 @@
+module BeStrong
+  module Rails
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load 'be_strong/rails/tasks.rake'
+      end
+    end
+  end
+end

data/lib/be_strong/rails/tasks.rake

@@ -0,0 +1,8 @@
+namespace :be_strong do
+  desc 'Apply strong parameter method and remove attr_accessible, attr_protected.'
+  task convert: :environment do
+    result = BeStrong::Converter.convert
+    result[:applied].each{|file| puts "Apply strong parameter: #{file}"}
+    result[:removed].each{|file| puts "Remove attr_[accessible|protected]: #{file}"}
+  end
+end

data/lib/be_strong/strong_parameter.rb

@@ -0,0 +1,23 @@
+module BeStrong
+  class StrongParameter
+    class << self
+      def apply_all(dir)
+        files = []
+        Dir.glob(File.join(dir, '**/*.rb')).each do |file|
+          applied = apply(file)
+          files << file if applied
+        end
+        files
+      end
+
+      def apply(file)
+        buf  = File.open(file, 'r'){|f| f.read}
+        code = Code.new(buf).apply_strong_parameter!
+        return false unless code.changed?
+
+        File.open(file, 'w'){|f| f.puts(code.to_str)}
+        true
+      end
+    end
+  end
+end

data/lib/be_strong/strong_parameter_methods.rb

@@ -0,0 +1,30 @@
+module BeStrong
+  class StrongParameterMethods
+    def self.method_for(name)
+      model = Model.new(name)
+      permits = model.accessible_attributes.map{|attr| ":#{attr}"}.join(', ')
+      permit_method = permits.present? ? ".permit(#{permits})" : ''
+
+      <<-"EOS".strip_heredoc
+        def #{name}_params
+          params.require(:#{name})#{permit_method}
+        end
+      EOS
+    rescue NameError
+      nil
+    end
+
+    class Model
+      def initialize(name)
+        @klass = name.to_s.classify.constantize
+      end
+
+      def accessible_attributes
+        accssible = @klass.accessible_attributes
+        return accssible if accssible.size.nonzero?
+
+        @klass.attribute_names - @klass.protected_attributes.to_a
+      end
+    end
+  end
+end

data/lib/be_strong/version.rb

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

data/lib/be_strong.rb

@@ -0,0 +1,11 @@
+require "be_strong/version"
+require "be_strong/strong_parameter.rb"
+require "be_strong/attr_accessible.rb"
+require "be_strong/code.rb"
+require "be_strong/strong_parameter_methods.rb"
+require "be_strong/converter.rb"
+require "be_strong/rails/railtie.rb" if defined?(Rails)
+
+module BeStrong
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: ae-be_strong
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- AppFolio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-07 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: protected_attributes
+  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: Strong parameter converter.
+email:
+- dev@appfolio.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- be_strong.gemspec
+- bin/console
+- bin/setup
+- lib/be_strong.rb
+- lib/be_strong/attr_accessible.rb
+- lib/be_strong/code.rb
+- lib/be_strong/converter.rb
+- lib/be_strong/rails/railtie.rb
+- lib/be_strong/rails/tasks.rake
+- lib/be_strong/strong_parameter.rb
+- lib/be_strong/strong_parameter_methods.rb
+- lib/be_strong/version.rb
+homepage: https://github.com/appfolio/be_strong
+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: Strong parameter converter.
+test_files: []