debride2okuribito 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 133ff1d2e9e25d6bc54b0bf764d0370b8f2698bb
+  data.tar.gz: 11b691a85d84a895e10cf83cb61acbe283fdffab
+SHA512:
+  metadata.gz: 81b774e11aab3b1ae03eb0eab80836313dd149b337050dc2f7150ce29c09104f04fbc049ae340973fae66843c52f35ac9f48594594c985a4af5ae454b38905bc
+  data.tar.gz: 64857b06dc513fdfa71c16b55d525b4c38d17bcc7372628dc39aaa4cb19b9fc23098ee0499848c8ad194478c665099a0ac16fed60e38701df1a9d5d60d7c2124

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright 2016 Yasuhiro Matsumura
+
+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,72 @@
+[![CircleCI](https://circleci.com/gh/muramurasan/debride2okuribito/tree/master.svg?style=shield)](https://circleci.com/gh/muramurasan/debride2okuribito/tree/master)
+[![Code Climate](https://codeclimate.com/github/muramurasan/debride2okuribito/badges/gpa.svg)](https://codeclimate.com/github/muramurasan/debride2okuribito)
+[![Test Coverage](https://codeclimate.com/github/muramurasan/debride2okuribito/badges/coverage.svg)](https://codeclimate.com/github/muramurasan/debride2okuribito/coverage)
+
+# DebrideToOkuribito
+
+https://rubygems.org/gems/debride2okuribito
+
+DebrideToOkuribito converts the execution result of "Debride" to yaml for "Okuribito".
+
+## Description citation
+
+### What is Debride
+
+> Analyze code for potentially uncalled / dead methods, now with auto-removal.
+
+Please, refer to the github repository for details: https://github.com/seattlerb/debride
+
+### What is Okuribito
+
+> Okuribito monitors the method call with YAML, and exec specified code.
+>
+> In other words, it can be used in order to extract the really uncalled method.
+
+Please, refer to the github repository for details: https://github.com/muramurasan/okuribito
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'debride2okuribito'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install debride2okuribito
+```
+
+## Usage
+
+Usage is very easy.
+
+If you enter the following command, you can get yaml for "Okuribito" with potentially uncalled methods written.
+
+```
+$ debride2okuribito ./
+--- Run debride...
+--- Convert yaml...
+--- 'okuribito.yml' has been generated.
+```
+
+The available options are "Debride" compliant.
+
+```
+$ debride2okuribito --rails app
+--- Run debride...
+--- Convert yaml...
+--- 'okuribito.yml' has been generated.
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+Copyright 2016 Yasuhiro Matsumura.

data/Rakefile

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

data/exe/debride2okuribito

@@ -0,0 +1,3 @@
+require "debride2okuribito"
+
+DebrideToOkuribito::Converter.new.convert_yaml(ARGV)

data/lib/debride2okuribito.rb

@@ -0,0 +1,54 @@
+require "debride"
+require "yaml"
+
+module DebrideToOkuribito
+  class Converter
+    FILE_NAME = "okuribito.yml".freeze
+
+    def convert_yaml(argv)
+      hash = read_debride(argv)
+      write_yaml(hash)
+    end
+
+    def read_debride(argv)
+      puts "--- Run debride and convert to yaml..."
+      debride = Debride.run(argv)
+      debride_to_hash(debride)
+    end
+
+    def write_yaml(hash)
+      yaml = YAML.dump(hash)
+
+      # Workaround...
+      yaml.gsub!(/^---\n/, "")
+      yaml.gsub!(/^- /, "  - ")
+
+      generate_file(yaml, FILE_NAME)
+      puts "--- 'okuribito.yml' has been generated."
+    end
+
+    private
+
+    def debride_to_hash(debride)
+      hash = {}
+      debride.missing.each do |klass, methods|
+        ary = []
+        methods.each do |method|
+          if debride.method_locations["#{klass}##{method}"]
+            ary << "##{method}"
+          elsif debride.method_locations["#{klass}::#{method}"]
+            ary << ".#{method}"
+          end
+        end
+        hash.store(klass, ary) unless ary.empty?
+      end
+      hash
+    end
+
+    def generate_file(obj, filename)
+      f = File.open(filename, "w")
+      f.write(obj)
+      f.close
+    end
+  end
+end

data/lib/debride2okuribito/version.rb

@@ -0,0 +1,3 @@
+module DebrideToOkuribito
+  VERSION = "0.1.0".freeze
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: debride2okuribito
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yasuhiro Matsumura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debride
+  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
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: It converts the execution result of 'Debride' to yaml for 'Okuribito'.
+email:
+- ym.contributor@gmail.com
+executables:
+- debride2okuribito
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- exe/debride2okuribito
+- lib/debride2okuribito.rb
+- lib/debride2okuribito/version.rb
+homepage: https://github.com/muramurasan/debride2okuribito
+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.1
+signing_key: 
+specification_version: 4
+summary: It converts the execution result of 'Debride' to yaml for 'Okuribito'.
+test_files: []