ruam 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee5bc981d769bbe0c6d4848921bd3205124a3a32
+  data.tar.gz: f8f3187089ecdf636d671e6dc1546761adf8d743
+SHA512:
+  metadata.gz: a2847de904ad7f367d1ec4de0cd00f1b5040f641c9fa6fcae55619dd7a3ed0bf5f31649bc70c748a029fee11872aec2146b431977902350e69294942d84f0a28
+  data.tar.gz: 94e5243e2236601114ca857f6c3d604c3092d1269897b28527bcc88d22750f7f89af3272b88bec7abe873d990b9972427c72f0d79a395c9dd5a95b2b4eb66773

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,40 @@
+Metrics/LineLength:
+  Max: 100
+
+Style/EndOfLine:
+  EnforcedStyle: lf
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MutableConstant:
+  AutoCorrect: false
+
+Style/SafeNavigation:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Exclude:
+    - spec/**/*
+
+Metrics/MethodLength:
+  Max: 15
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/AbcSize:
+  Max: 20
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+Metrics/CyclomaticComplexity:
+  Max: 7
+
+Performance/RedundantMerge:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change log
+
+## 1.0.0
+
+first release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (C) 2017 autopp
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.

data/README.md

@@ -0,0 +1,74 @@
+# Ruam
+[![Gem Version](https://badge.fury.io/rb/ruam.svg)](https://badge.fury.io/rb/ruam)
+[![Build Status](https://circleci.com/gh/autopp/ruam.svg?style=shield&circle-token=21fbc0adbc3428399a27b0f1334dd52ff22d8fd8)](https://circleci.com/gh/autopp/ruam)
+
+Ruam is a simple command line tool to inspect a byte code of Ruby script.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruam'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruam
+
+## Usage
+
+```
+$ cat hello.rb
+puts 'hello world'
+
+$ ruam hello.rb
+== disasm: #<ISeq:<main>@hello.rb>======================================
+0000 trace            1                                               (   1)
+0002 putself          
+0003 putstring        "hello world"
+0005 opt_send_without_block <callinfo!mid:puts, argc:1, FCALL|ARGS_SIMPLE>, <callcache>
+0008 leave            
+```
+
+If file name is not given, `ruam` read from stdin:
+
+```
+$ echo "puts 'hello world'" | ruam
+== disasm: #<ISeq:<compiled>@<compiled>>================================
+0000 trace            1                                               (   1)
+0002 putself          
+0003 putstring        "hello world"
+0005 opt_send_without_block <callinfo!mid:puts, argc:1, FCALL|ARGS_SIMPLE>, <callcache>
+0008 leave            
+```
+
+You can enable/disable compile option which are [defined in the VM](https://docs.ruby-lang.org/en/2.4.0/RubyVM/InstructionSequence.html#method-c-compile_option-3D):
+
+```
+$ ruam hello.rb --no-trace-instruction
+== disasm: #<ISeq:<main>@hello.rb>======================================
+0000 putself                                                          (   1)
+0001 putstring        "hello world"
+0003 opt_send_without_block <callinfo!mid:puts, argc:1, FCALL|ARGS_SIMPLE>, <callcache>
+0006 leave            
+```
+
+For more info, execute `ruam -h`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruam.
+
+
+## Lisence
+
+[Apache License 2.0](LICENSE)
+
+## Author
+
+[@AuToPP](https://twitter.com/AuToPP)

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 'ruam'
+
+# 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

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/circle.yml

@@ -0,0 +1,18 @@
+dependencies:
+  pre:
+    - gem install bundler
+
+test:
+  post:
+    - bundle exec ruam lib/ruam.rb
+    - bundle exec rubocop -D
+
+deployment:
+  rubygems:
+    tag: /v[0-9]+(\.[0-9]+)*/
+    owner: autopp
+    commands:
+      - git config --local user.name "autopp"
+      - git config --local user.email "autopp@gmail.com"
+      - 'echo ":rubygems_api_key: ${RUBYGEMS_API_KEY}" > ~/.gem/credentials && chmod 0600 ~/.gem/credentials'
+      - bundle exec rake release

data/exe/ruam

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# Copyright (C) 2017 autopp
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+require 'ruam'
+
+begin
+  Ruam.run(ARGV)
+rescue Ruam::Options::ParseError, IOError, Errno::ENOENT => e
+  $stderr.puts e.message
+  exit 1
+end

data/lib/ruam.rb

@@ -0,0 +1,38 @@
+# Copyright (C) 2017 autopp
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+require 'ruam/version'
+
+# Top level namespace for ruam
+#
+module Ruam
+  def self.optimization_flags
+    RubyVM::InstructionSequence.compile_option.keys - %i[debug_level]
+  end
+
+  def self.run(argv)
+    options = Options.parse(argv)
+    file = options[:file]
+    compile_options = RubyVM::InstructionSequence.compile_option.merge(options[:compile_options])
+
+    insns = if file
+              RubyVM::InstructionSequence.compile_file(file, compile_options)
+            else
+              RubyVM::InstructionSequence.compile($stdin.read, nil, nil, 1, compile_options)
+            end
+    puts insns.disasm
+  end
+end
+
+require 'ruam/options'

data/lib/ruam/options.rb

@@ -0,0 +1,49 @@
+# Copyright (C) 2017 autopp
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+require 'optparse'
+
+module Ruam
+  # Command line option parser
+  #
+  class Options
+    def self.parse(argv)
+      options = { compile_options: {} }
+      parser = create_parser(options[:compile_options])
+      begin
+        argv = parser.parse(argv)
+        raise ParseError, 'more than one file is specified' if argv.size > 1
+      rescue OptionParser::InvalidOption => e
+        raise ParseError, e.message
+      end
+      options[:file] = argv.first
+      options
+    end
+
+    def self.create_parser(options)
+      parser = OptionParser.new
+      Ruam.optimization_flags.each do |flag|
+        parser.on("--[no-]#{flag.to_s.tr('_', '-')}") do |v|
+          options[flag] = v
+        end
+      end
+      parser.on('--debug-level=LEVEL') do |v|
+        options[:debug_level] = v.to_i
+      end
+    end
+
+    class ParseError < StandardError
+    end
+  end
+end

data/lib/ruam/version.rb

@@ -0,0 +1,17 @@
+# Copyright (C) 2017 autopp
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+module Ruam
+  VERSION = '1.0.0'.freeze
+end

data/ruam.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ruam/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ruam'
+  spec.version       = Ruam::VERSION
+  spec.authors       = ['autopp']
+  spec.email         = ['autopp.inc@gmail.com']
+
+  spec.summary       = 'Command line tool to show byte code of Ruby script'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/autopp/ruam'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.48'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: ruam
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- autopp
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+description: Command line tool to show byte code of Ruby script
+email:
+- autopp.inc@gmail.com
+executables:
+- ruam
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- exe/ruam
+- lib/ruam.rb
+- lib/ruam/options.rb
+- lib/ruam/version.rb
+- ruam.gemspec
+homepage: https://github.com/autopp/ruam
+licenses: []
+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.11
+signing_key: 
+specification_version: 4
+summary: Command line tool to show byte code of Ruby script
+test_files: []