railsbp_in_browser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5955b884ba8a7801aba7b6caad4ecd3e0181e8c
+  data.tar.gz: 3be44d089df11b965876cdecdc906e8c7edbab71
+SHA512:
+  metadata.gz: 6a835a4ed3f0933d9dd6ae8d755f1b4dda4315f93503970b5a7729ff290d520d1e7974ad3771f8737f5f504c18c083aa4ffc67330488acd94f40397af186076b
+  data.tar.gz: 9acc685671ed71b5f0c0cb3d1051b766bdd9263b922145e870ea76acaf1bb7196e3cb8623c015d3f8a4ff41ae19f9b765b432e026b0138918bfc26340848fffd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ljp.hiveer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

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

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    railsbp_in_browser (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    code_analyzer (0.4.8)
+      sexp_processor
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    erubis (2.7.0)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    minitest (5.11.3)
+    public_suffix (3.0.2)
+    rails_best_practices (1.19.1)
+      activesupport
+      code_analyzer (>= 0.4.8)
+      erubis
+      i18n
+      json
+      require_all (~> 1.5.0)
+      ruby-progressbar
+    rake (10.5.0)
+    require_all (1.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    ruby-progressbar (1.9.0)
+    sexp_processor (4.11.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  launchy
+  rails_best_practices
+  railsbp_in_browser!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Hiveer
+
+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,43 @@
+# RailsbpInBrowser
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/railsbp_in_browser`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'railsbp_in_browser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install railsbp_in_browser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/railsbp_in_browser. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RailsbpInBrowser project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/railsbp_in_browser/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
+
+require 'railsbp_in_browser'
+
+RailsbpInBrowser.generate_html

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

@@ -0,0 +1,58 @@
+require "railsbp_in_browser/version"
+require "railsbp_in_browser/online_docs"
+require 'launchy'
+
+module RailsbpInBrowser
+  class << self
+    def get_article_name str
+      reg = /([a-zA-Z0-9 _]+)\(?.*/
+      key = if reg.match str
+        $1.strip.downcase
+      else
+        ""
+      end
+      OnlineDocs::DOC_MAPPINGS[key]
+    end
+
+    def generate_html
+      puts "Generating the code climate ..."
+      `rails_best_practices . > rails_best_practices_output.html`
+
+      f = File.open("rails_best_practices_output.html")
+      of = File.open("code_climate.html", 'w')
+      reg = /.*\[31m(.*):([0-9]+) - (.*)\e.*/
+      f.each_line do |line|
+        next unless reg.match(line)
+        match_line = $2
+        match_file = $1
+        article_name = $3
+        if get_article_name(article_name)
+          of.puts("<h2><a target='_blank' href=#{get_article_name(article_name)}>#{article_name}</a></h2>")
+        else
+          of.puts("<h2>#{article_name}</h2>")
+        end
+        of.puts("<p>#{match_file.gsub(Dir.pwd, '')}:<strong style=\"background-color:darkseagreen\">#{match_line}</strong></p>")
+        ffa = File.open(match_file).to_a
+        of.puts("<div style=\"background-color:lightgrey;margin-left:50\">")
+        start = match_line.to_i - 5 > 0 ? match_line.to_i - 5 : 0
+        (start .. match_line.to_i + 5).each do |index|
+          if ffa[index] && (index + 1) == match_line.to_i
+            of.puts("<code style=\"background-color:darkseagreen\">#{index+1} - #{ffa[index].gsub('<', '&lt;').gsub('>', '&gt;')}</code><br>")
+          elsif ffa[index]
+            of.puts("<code>#{index+1} - #{ffa[index].gsub('<', '&lt;').gsub('>', '&gt;')}</code><br>")
+          end
+        end
+        of.puts("</div>")
+      end
+
+      f.close
+      of.close
+
+      puts "Open file in Chrome"
+      Launchy::Browser.run('./code_climate.html')
+
+      `rm rails_best_practices_output.html`
+      `rm code_climate.html`
+    end
+  end
+end

data/lib/railsbp_in_browser/online_docs.rb

@@ -0,0 +1,39 @@
+module RailsbpInBrowser
+  module OnlineDocs
+    DOC_MAPPINGS = {
+      "add model virtual attribute" => "https://rails-bestpractices.com/posts/2010/07/21/add-model-virtual-attribute/",
+      "always add db index" => "https://rails-bestpractices.com/posts/2010/07/24/always-add-db-index/",
+      "check return value of save otherwise use save" => "https://rails-bestpractices.com/posts/2012/11/02/check-the-return-value-of-save-otherwise-use-save/",
+      "default_scope is evil" => "https://rails-bestpractices.com/posts/2013/06/15/default_scope-is-evil/",
+      "dry bundler in capistrano" => "https://rails-bestpractices.com/posts/2010/09/02/dry-bundler-in-capistrano/",
+      "isolating seed data" => "https://rails-bestpractices.com/posts/2010/07/24/isolating-seed-data/",
+      "keep finders on their own model" => "https://rails-bestpractices.com/posts/2010/07/23/keep-finders-on-their-own-model/",
+      "law of demeter" => "https://rails-bestpractices.com/posts/2010/07/24/the-law-of-demeter/",
+      "move code into controller" => "https://rails-bestpractices.com/posts/2010/07/24/move-code-into-controller/",
+      "move code into helper" => "https://rails-bestpractices.com/posts/2010/07/24/move-code-into-helper/",
+      "move code into model" => "https://rails-bestpractices.com/posts/2010/07/24/move-code-into-model/",
+      "move finder to named_scope" => "https://rails-bestpractices.com/posts/2010/07/14/move-finder-to-named_scope/",
+      "move model logic into model" => "https://rails-bestpractices.com/posts/2010/07/21/move-model-logic-into-the-model/",
+      "needless deep nesting" => "https://rails-bestpractices.com/posts/2010/07/22/needless-deep-nesting/",
+      "don't rescue exception" => "https://rails-bestpractices.com/posts/2012/11/01/don-t-rescue-exception-rescue-standarderror/",
+      "not use default route if you use restful design" => "https://rails-bestpractices.com/posts/2010/07/22/not-use-default-route-if-you-use-restful-design/",
+      "not use time_ago_in_words" => "https://rails-bestpractices.com/posts/2012/02/10/not-use-time_ago_in_words/",
+      "overuse route customizations" => "https://rails-bestpractices.com/posts/2010/07/22/overuse-route-customizations/",
+      "protect mass assignment" => "https://rails-bestpractices.com/posts/2012/03/06/protect-mass-assignment/",
+      "remove empty helpers" => "https://rails-bestpractices.com/posts/2011/04/09/remove-empty-helpers/",
+      "replace complex creation wit factory method" => "https://rails-bestpractices.com/posts/2010/07/21/replace-complex-creation-with-factory-method/",
+      "replace instance variable with local variable" => "https://rails-bestpractices.com/posts/2010/07/24/replace-instance-variable-with-local-variable/",
+      "restrict auto generated routes" => "https://rails-bestpractices.com/posts/2011/08/19/restrict-auto-generated-routes/",
+      "simplify render in controllers" => "https://rails-bestpractices.com/posts/2010/12/12/simplify-render-in-controllers/",
+      "simplify render in views" => "https://rails-bestpractices.com/posts/2010/12/04/simplify-render-in-views/",
+      "use before_filter" => "https://rails-bestpractices.com/posts/2010/07/24/use-before_filter/",
+      "use model assignment" => "https://rails-bestpractices.com/posts/2010/07/19/use-model-association/",
+      "use multipart alternative as content_type of email" => "https://rails-bestpractices.com/posts/2010/08/05/use-multipart-alternative-as-content_type-of-email/",
+      "use observer" => "https://rails-bestpractices.com/posts/2010/07/24/use-observer/",
+      "use query attribute" => "https://rails-bestpractices.com/posts/2010/10/03/use-query-attribute/",
+      "use say and say_with_time in migrations to make a useful migration log" => "https://rails-bestpractices.com/posts/2010/08/19/use-say-and-say_with_time-in-migrations-to-make-a-useful-migration-log/",
+      "use scope access" => "https://rails-bestpractices.com/posts/2010/07/20/use-scope-access/",
+      "speed up assets precompile with turbo sprockets rails3" => "https://rails-bestpractices.com/posts/2012/11/23/speed-up-assets-precompile-with-turbo-sprockets-rails3/"
+    }
+  end
+end

data/lib/railsbp_in_browser/version.rb

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

data/railsbp_in_browser.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "railsbp_in_browser/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "railsbp_in_browser"
+  spec.version       = RailsbpInBrowser::VERSION
+  spec.authors       = ["Hiveer"]
+  spec.email         = ["ljp.hiveer@gmail.com"]
+
+  spec.summary       = %q{Generate code climate page based on rails_best_practices}
+  spec.description   = %q{Generate code climate page based on rails_best_practices}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+    # raise "RubyGems 2.0 or newer is required to protect against " \
+      # "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  # spec.bindir        = "exe"
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rails_best_practices"
+  spec.add_development_dependency "launchy"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: railsbp_in_browser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hiveer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails_best_practices
+  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: launchy
+  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: Generate code climate page based on rails_best_practices
+email:
+- ljp.hiveer@gmail.com
+executables:
+- console
+- railsbp_in_browser
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/railsbp_in_browser
+- bin/setup
+- lib/railsbp_in_browser.rb
+- lib/railsbp_in_browser/online_docs.rb
+- lib/railsbp_in_browser/version.rb
+- railsbp_in_browser.gemspec
+homepage: ''
+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: Generate code climate page based on rails_best_practices
+test_files: []