plock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5a704c97cf4dfbc0119fc10c4df6448bdae7c1b
+  data.tar.gz: 3c7879a0acf310be0dc27b467f1da2f4a0dd39f0
+SHA512:
+  metadata.gz: 628c348bcd5506c7203f75ef4ce30fab2862aa79744fd52c8eb740e74cb91f6ead05c67d07b4f2cc8cb7216eff5bc5568f453570b2b5ef09a8cb714c0254b84a
+  data.tar.gz: 6db35537b4c6152b32a7a9aace878b74d85cfb1c383f291cf25272d8b503a70cd5406936dc9b0314de7c2d1c64444739add6bbd15c7ea9b2dea253114cac21ea

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yamamoto Yuji
+
+MIT License
+
+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,30 @@
+# Plock
+
+p + block = plock. 'p { 1 + 1 }` prints "(1 + 1) #=> 2". That's all.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'plock'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install plock
+
+## Known Bugs
+**Important Note:** Plock depends on [sourcify](https://github.com/ngty/sourcify) (so far), it has a big restriction:
+
+- You can't use on REPLs such as pry, irb and so on: you have to use p/pp in a source code saved on the disk.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/plock/version.rb

@@ -0,0 +1,3 @@
+module Plock
+  VERSION = "0.0.1"
+end

data/lib/plock.rb

@@ -0,0 +1,78 @@
+require 'sourcify'
+require 'pp'
+
+require "plock/version"
+
+module Plock
+  module Format
+    PERCENT_B = '%b'.freeze
+    PERCENT_R = '%r'.freeze
+    DEFAULT_FORMAT = "#{PERCENT_B} #=> #{PERCENT_R}".freeze
+  end
+
+  class << self
+    attr_writer :output_format
+    def output_format
+      @output_format ||= self::Format::DEFAULT_FORMAT
+    end
+
+    def inspect_block( attached = :inspect_block, &block )
+      result = block.call
+      [ block.to_source( attached_to: attached, strip_enclosure: true ), result ]
+    end
+
+    def print_block_with formatter_method, attached, *args, &block
+      returned = []
+      returned.concat args
+
+      block_source, block_result = Plock.inspect_block( attached, &block )
+
+      puts self.__send__( formatter_method, block_source, block_result )
+
+      returned << block_result
+      returned.length > 1 ? returned : returned.first
+    end
+
+    def format_with block_source, block_result, inspect_method
+      result = self.output_format.dup
+      result.sub! self::Format::PERCENT_B, block_source
+      result.sub! self::Format::PERCENT_R, block_result.__send__( inspect_method )
+      return result
+    end
+
+    def format block_source, block_result
+      self.format_with block_source, block_result, :inspect
+    end
+
+    if Object.public_method_defined? :pretty_inspect
+      def pretty_format block_source, block_result
+        self.format_with block_source, block_result, :pretty_inspect
+      end
+    end
+  end
+
+end
+
+module Kernel # reopen
+  alias p_without_plock p
+  def p_with_plock *args, &block
+    if block_given?
+      Plock.print_block_with :format, :p, *args, &block
+    else
+      p_without_plock( *args )
+    end
+  end
+  alias p p_with_plock
+
+  if Kernel.private_method_defined? :pp
+    alias pp_without_plock pp
+    def pp_with_plock
+      if block_given?
+        Plock.print_block_with :pretty_format, :pp, *args, &block
+      else
+        pp_without_plock( *args )
+      end
+    end
+    alias pp pp_with_plock
+  end
+end

data/plock.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'plock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "plock"
+  spec.version       = Plock::VERSION
+  spec.authors       = ["Yamamoto Yuji"]
+  spec.email         = ["whosekiteneverfly@gmail.com"]
+  spec.description   = %q{'p { 1 + 1 }` prints "1 + 1 #=> 2". That's all.}
+  spec.summary       = %q{'p { 1 + 1 }` prints "1 + 1 #=> 2". That's all.}
+  spec.homepage      = "https://github.com/igrep/plock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sourcify"
+end

data/spec/plock_spec.rb

@@ -0,0 +1,46 @@
+require 'plock'
+require 'stringio'
+
+describe Plock do
+  describe '.inspect_block ' do
+    subject do
+      a = 1
+      described_class.inspect_block { a + 1 }
+    end
+    it { should eq ['(a + 1)', 2] }
+  end
+  describe '.format' do
+    context 'when Plock.output_format = "%b #=> %r"' do
+      before { described_class.output_format = "%b #=> %r" }
+      subject { described_class.format '(a + 1)', 2 }
+      it { should eq '(a + 1) #=> 2' }
+      it 'never changes the output_format desructively' do
+        described_class.output_format = '%b and %r SHOULD NOT BE CHANGED'
+        described_class.format 'block', 'result'
+        described_class.output_format.should eq '%b and %r SHOULD NOT BE CHANGED'
+      end
+    end
+  end
+end
+
+RSpec::Matchers.define :include_when_ignoring_space_difference do|expected|
+  match do|actual|
+    expected.gsub( /\s+/, '' ).include? actual.gsub( /\s+/, '' )
+  end
+end
+
+describe Kernel do
+  describe '#p' do
+    before( :all ) { $stdout = StringIO.new '', 'wb' } # replaces the stdin for testing the output of p
+    context 'when Plock.output_format = "%b #=> %r"' do
+      before( :all ) { Plock.output_format = "%b #=> %r" }
+      let( :no_percent ){ Plock.output_format.gsub( /%[br]/, '' ) }
+      subject { p { 1 + 1 } }
+      it { should be 2 }
+      it 'prints out the block and its result onto stdin' do
+        $stdout.string.should include_when_ignoring_space_difference "(1 + 1) #{no_percent} 2"
+      end
+    end
+    after( :all ) { $stdout = STDOUT } # restore default stdin
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: plock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yamamoto Yuji
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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: sourcify
+  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: '''p { 1 + 1 }` prints "1 + 1 #=> 2". That''s all.'
+email:
+- whosekiteneverfly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/plock.rb
+- lib/plock/version.rb
+- plock.gemspec
+- spec/plock_spec.rb
+homepage: https://github.com/igrep/plock
+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.0.0
+signing_key: 
+specification_version: 4
+summary: '''p { 1 + 1 }` prints "1 + 1 #=> 2". That''s all.'
+test_files:
+- spec/plock_spec.rb