rin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89e40f1f24bf5249a57601996d351d6edcbf28ea
+  data.tar.gz: a43fc75f22f239d57f81aff28a9aa32afb2c1a30
+SHA512:
+  metadata.gz: 1b5bfabb728c38eb8ebc33c42078046f5d2cee4442212af557dba3454a521849162bfad5ecfd49fa654f39dfdfc0b133260e54cd5a1324904acb0b8dce2d9b92
+  data.tar.gz: 24975450e1fe82b702f07f4f490c9bd207ca75c771af11c69157b9c3bb019093f65ab670105b7e76103e5cce1fac2dee50eef9d564d8807d0dbce860710e4564

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+script: bundle exec rspec
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.2
+  - 2.2.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Readme.md

@@ -0,0 +1,91 @@
+[![Build Status](https://secure.travis-ci.org/JoshCheek/rin.png?branch=master)](http://travis-ci.org/JoshCheek/rin)
+
+Rin: Inspects Ruby Integers
+===========================
+
+Change the base that numbers display with in Ruby.
+
+
+The executable
+--------------
+
+Prints whatever the script evaluates to.
+Default inspect is hex.
+
+```sh
+$ rin '170 + 17'
+BB
+```
+
+Can be told what base to use by passing the base as a flag.
+
+```sh
+$ rin -8 '7 + 7'
+16
+```
+
+You can put whatever Ruby you want in there.
+
+From a Ruby commandline script
+------------------------------
+
+From the shell, you can require rin, and output will be set by default to hex,
+or to the base of the first argument to the script.
+
+```sh
+$ ruby -rin -e 'p 15'
+0xF
+```
+
+
+Polite Ruby script
+------------------
+
+Use in Ruby without fucking with the environment.
+
+```ruby
+require 'rin'
+rin.hex { 15 }  # => "0xF"
+rin.oct { 15 }  # => "017"
+rin.bin { 15 }  # => "0b1111"
+rin.dec { 15 }  # => "15"
+```
+
+
+Invasive Ruby script
+--------------------
+
+But less annoying to use
+
+```
+15 # => 15
+
+rin.hex!
+15 # => 0xF
+
+rin.dec!
+15 # => 15
+```
+
+Other things that could be fun
+------------------------------
+
+But that I don't intend to do,
+unless I use this much.
+
+* env var for for config:
+  * preferred base
+  * preferred format (eg uppercase/lowercase/whatev)
+* Support Ruby's executable arguments
+* Support `String#to_i`
+* Support `[1..100].map(&Rin.hex)`
+* It has a naive preprocessor that swaps them to the correct values.
+  Eventually would be nice to get this:
+  ```sh
+  $ rin 'AA + 11'
+  BB
+  ```
+  * exit statuses be meaningful
+    eg `rin 'BB == (AA + 11)` exits with 0
+  * `0d123` for decimal
+  * Case insensitive

data/bin/rin

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+program      = nil
+base         = 16
+print_result = true
+print_help   = false
+unknown_args = []
+
+ARGV.each do |arg|
+  case arg
+  when '-P'
+    print_result = false
+  when '-h', '--help'
+    print_help = true
+  when /^-(\d+)$/
+    base = $1.to_i
+  when /^-.*/
+    unknown_args << arg
+  else
+    program = arg
+  end
+end
+
+if print_help
+  $stdout.puts "Usage: rin [-base] [-P] [-h] program"
+  $stdout.puts ""
+  $stdout.puts "Synopsis:"
+  $stdout.puts "  Inspects Ruby Integers"
+  $stdout.puts ""
+  $stdout.puts "Examples:"
+  $stdout.puts "  $ rin '7+8'    # prints \"E\""
+  $stdout.puts "  $ rin -8 '7+2' # prints \"11\""
+  $stdout.puts "  Instead of printing, write to a file"
+  $stdout.puts "    $ rin -P 'File.write \"out\", (7+8).inspect'"
+  $stdout.puts ""
+  $stdout.puts "Flags:"
+  $stdout.puts "  -base sets the base to that number"
+  $stdout.puts "  defaults to 16 (hex)"
+  $stdout.puts "  eg: -2 for binary, -8 for octal"
+  $stdout.puts ""
+  $stdout.puts "  -P    turns off program result autoprinting"
+elsif unknown_args.any?
+  $stderr.puts "Unknown arguments: #{unknown_args.inspect}"
+  exit 1
+elsif !program
+  $stderr.puts "No code specified, run with -h for examples"
+  exit 1
+else
+  require 'rin'
+  begin
+    rin.base base do
+      result = binding.eval program, '-e'
+      p result if print_result
+    end
+  rescue ArgumentError => e
+    $stderr.puts e.message
+    exit 1
+  end
+end

data/lib/in.rb

@@ -0,0 +1 @@
+require 'rin' # hook to enable `ruby -rin`

data/lib/rin.rb

@@ -0,0 +1,103 @@
+def rin
+  Rin.instance
+end
+
+class Rin
+  def self.instance
+    @instance ||= begin
+      instance = new(10)
+      instance.enable!
+      instance
+    end
+  end
+
+  def initialize(base)
+    @base = base
+    @inspects = {
+      Fixnum => Fixnum.instance_method(:inspect),
+      Bignum => Bignum.instance_method(:inspect),
+    }
+  end
+
+  def disable!
+    @inspects.each do |klass, original|
+      define_inspect klass, original
+    end
+  end
+
+  def enable!
+    @inspects.each do |klass, _original|
+      define_inspect klass, Proc.new {
+        Rin.instance.inspect_num self
+      }
+    end
+  end
+
+  # uhm... returns the base if no base is given
+  # if base is given, it sets the base to that and calls the block
+  def base(set_base=false, &block)
+    return @base unless set_base
+    temporary_base set_base, &block
+  end
+
+  def inspect_num(n)
+    n.to_s(@base).upcase
+  end
+
+  def hex(&block)
+    temporary_base 16, &block
+  end
+
+  def hex!
+    @base = 16
+  end
+
+  def oct(&block)
+    temporary_base 8, &block
+  end
+
+  def oct!
+    @base = 8
+  end
+
+  def bin(&block)
+    temporary_base 2, &block
+  end
+
+  def bin!
+    @base = 2
+  end
+
+  def dec(&block)
+    temporary_base 10, &block
+  end
+
+  def dec!
+    @base = 10
+  end
+
+  private
+
+  def define_inspect(klass, method_def)
+    klass.class_eval do
+      define_method :inspect, method_def
+    end
+  end
+
+  def temporary_base(overriden_base, &block)
+    validate_base! overriden_base
+    initial_base = @base
+    @base = overriden_base
+    block.call
+  ensure
+    @base = initial_base if initial_base # don't reset to nil, when error is raised
+  end
+
+  def validate_base!(base)
+    1.to_s base
+  rescue ArgumentError
+    raise ArgumentError, "Invalid base: #{base.inspect}"
+  end
+end
+
+rin.hex! if $0 == '-e' # stupid that accessing the var turns it on

data/rin.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name        = "rin"
+  s.version     = '0.0.1'
+  s.authors     = ["Josh Cheek"]
+  s.email       = ["josh.cheek@gmail.com"]
+  s.homepage    = "https://github.com/JoshCheek/rin"
+  s.summary     = %q{Make it easier to script with numbers of alternate bases.}
+  s.description = %q{bin/lib that overrides inspect on integers to print numbers in a desired base}
+  s.license     = "WTFPL"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_development_dependency "rspec", '~> 3.0'
+end

data/spec/integration_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+spec_helpers = Module.new do
+  def matcher_for(str_or_regex)
+    case str_or_regex
+    when Regexp then match str_or_regex
+    else             eq    str_or_regex
+    end
+  end
+
+  def runs!(*program)
+    opts   = program.pop if program.last.kind_of? Hash
+    out    = opts.fetch :out,    //
+    err    = opts.fetch :err,    ""
+    status = opts.fetch :status, 0
+
+    actual_out, actual_err, actual_status = Open3.capture3(*program)
+
+    expect(actual_err).to matcher_for(err)
+    expect(actual_out).to matcher_for(out)
+    expect(actual_status.exitstatus).to eq status
+  end
+end
+
+RSpec.describe '$ rin' do
+  include spec_helpers
+
+  it 'prints the inspection of whatever the script evaluates to' do
+    runs! 'rin', '"hello"', out: %'"hello"\n'
+  end
+
+  it 'sets __FILE__ to "-e", like Ruby\'s -e' do
+    runs! 'rin', '__FILE__', out: %'"-e"\n'
+  end
+
+  it 'accepts preferred base as flags' do
+    runs! 'rin', '-8', '7 + 7', out: "16\n"
+  end
+
+  it 'defaults the base to hex' do
+    runs! 'rin', '7 + 7', out: "E\n"
+  end
+
+  it 'translates things that are probably numbers into the correct base'
+
+  specify '-P turns off autoprinting' do
+    runs! 'rin', '-P', '1+1', out: ''
+  end
+
+  it 'sets the base before printing' do
+    runs! 'rin', '15.inspect', out: %'"F"\n'
+  end
+
+  it 'prints help on -h and --help' do
+    runs! 'rin', '-h',     out: /usage/i
+    runs! 'rin', '--help', out: /usage/i
+  end
+
+  describe 'errors' do
+    it 'notifies you if you omit the program' do
+      runs! 'rin', '-8', '-P', status: 1,
+                               err:    /no code specified/i,
+                               out:    ''
+    end
+
+    it 'notifies you if you choose an invalid base' do
+      runs! 'rin', '-36', '1', status: 0
+      runs! 'rin', '-37', '1', status: 1,
+                               err:    /invalid base/i,
+                               out:    ''
+    end
+
+    it 'notifies you if you supply an unknown arg' do
+      runs! 'rin', '-', '1', status: 1,
+                             err:    /unknown arg.*?"-"/i,
+                             out:    ''
+    end
+  end
+end
+
+
+RSpec.describe '$ ruby -rin -e' do
+  include spec_helpers
+
+  it 'defaults the base to hex' do
+    runs! 'ruby', '-rin', '-e', 'p 7 + 7', out: "E\n"
+  end
+
+  it 'translates things that are probably numbers into the correct base'
+end

data/spec/rin_spec.rb

@@ -0,0 +1,98 @@
+require 'spec_helper'
+require 'rin'
+
+# base!
+
+RSpec.describe 'rin' do
+  specify 'always returns the same object' do
+    # call it under various different `self`s
+    expect(rin).to equal Object.new.instance_eval { rin }
+  end
+
+  describe '.base(n) { ... }' do
+    specify '.base(n) { ... } allows for arbitrary base overrides' do
+      twenty_four_base_thirteen =
+        rin.base(13) { (12 + 12).inspect }
+      expect(twenty_four_base_thirteen).to eq '1B'
+    end
+
+    it 'resets the base on .<base> { ... }, even if the block raises an exception' do
+      expect {
+        rin.hex do
+          expect(rin.base).to eq 16
+          raise 'zomg'
+        end
+      }.to raise_error RuntimeError, 'zomg'
+      expect(rin.base).to eq 10
+    end
+
+    it 'raises the ArgumentError that to_s would, if given an invalid base' do
+      expect { 15.to_s 37 }.to raise_error ArgumentError, /invalid/i
+      expect { rin.base(37) { nil } }.to raise_error ArgumentError, /invalid/i
+      expect(rin.base).to eq 10
+    end
+  end
+
+  describe 'named bases' do
+    def self.test_named_base(basename, base, tests)
+      specify ".#{basename} { ... } sets the inspect to base #{base} within the block" do
+        tests.each do |int, (dec_inspect, base_inspect)|
+          expect(int.inspect).to eq dec_inspect
+          rin.__send__ basename do
+            expect(int.inspect).to eq base_inspect
+          end
+          expect(int.inspect).to eq dec_inspect
+        end
+      end
+
+      specify ".#{basename}! sets the inspect to #{base} permanently" do
+        tests.each do |int, (dec_inspect, base_inspect)|
+          expect(int.inspect).to eq dec_inspect
+          rin.__send__ "#{basename}!"
+          expect(int.inspect).to eq base_inspect
+          rin.dec!
+        end
+      end
+    end
+
+    test_named_base 'hex', 16, 15 => ['15', 'F']
+    test_named_base 'oct',  8, 15 => ['15', '17']
+    test_named_base 'bin',  2, 10 => ['10', '1010']
+    test_named_base 'dec', 10, 15 => ['15', '15']
+  end
+
+  it 'exposes the current base' do
+    expect(rin.base).to eq 10
+  end
+
+  it 'returns the block value on .<base>' do
+    expect(rin.hex { 'zomg' }).to eq 'zomg'
+  end
+
+  it 'works for bignums' do
+    n = 10**1000
+    expect(n).to be_a_kind_of Bignum
+    expect(rin.hex { n.inspect })
+      .to eq n.to_s(16).upcase
+  end
+
+  it 'supports nested overrides' do
+    expect(15.inspect).to eq '15'
+    rin.hex do
+      expect(15.inspect).to eq 'F'
+      rin.oct { expect(15.inspect).to eq '17' }
+      expect(15.inspect).to eq 'F'
+    end
+    expect(15.inspect).to eq '15'
+  end
+
+  it 'can be enabled and disabled' do
+    rin.hex!
+    expect(15.inspect).to eq 'F'
+    rin.disable!
+    expect(15.inspect).to eq '15'
+    rin.enable!
+    expect(15.inspect).to eq 'F'
+    rin.dec!
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'open3'
+
+lib_path       = File.expand_path '../../lib', __FILE__
+bin_path       = File.expand_path '../../bin', __FILE__
+ENV['PATH']    = "#{bin_path}:#{ENV['PATH']}"
+ENV['RUBYOPT'] = "-I #{lib_path} #{ENV['RUBYOPT']}"
+
+RSpec.configure do |config|
+  config.disable_monkey_patching!
+  config.fail_fast = true
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Josh Cheek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-22 00:00:00.000000000 Z
+dependencies:
+- !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: bin/lib that overrides inspect on integers to print numbers in a desired
+  base
+email:
+- josh.cheek@gmail.com
+executables:
+- rin
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Readme.md
+- bin/rin
+- lib/in.rb
+- lib/rin.rb
+- rin.gemspec
+- spec/integration_spec.rb
+- spec/rin_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/JoshCheek/rin
+licenses:
+- WTFPL
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Make it easier to script with numbers of alternate bases.
+test_files:
+- spec/integration_spec.rb
+- spec/rin_spec.rb
+- spec/spec_helper.rb