tapp 1.3.1 → 1.4.0

data/.rspec

@@ -1 +1 @@
--r turnip
+-r turnip/rspec

data/CHANGELOG.md

@@ -1,17 +1,29 @@
 # ChangeLog
 
-## 1.3.0
+## 1.4.0 (2012-07-08)
 
-* Add `tapp` command-line tool. (ursm)
+Some API changes for future enhancements.
 
-## 1.2.0
+* Added `Tapp.config` and `Tapp.configure`. See README.md for details.
+* `Tapp.verbose` moved to `Tapp.config.report_caller`.
+* `Object#taap` is deprecated. Set `Tapp.config.default_printer = :awesome_print` and use `#tapp` instead.
 
-* Add `Tapp.verbose` option. (moro)
+## 1.3.1 (2012-03-13)
 
-## 1.1.0
+* `tapp grep` finds "taputs" and "taap". (@kei-s)
 
-* `Object#taap` support awesome\_print (Thanks ryopeko!)
+## 1.3.0 (2011-11-01)
 
-## 1.0.0
+* Add `tapp` command-line tool. (@ursm)
+
+## 1.2.0 (2011-10-27)
+
+* Add `Tapp.verbose` option. (@moro)
+
+## 1.1.0 (2011-07-06)
+
+* `Object#taap` support `awesome_print`. (Thanks @ryopeko!)
+
+## 1.0.0 (2010-07-07)
 
 initial release

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Keita Urashima
+Copyright (c) 2010-2012 Keita Urashima
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,61 @@
+# tapp ![Build Status](https://secure.travis-ci.org/esminc/tapp.png?branch=master)
+
+## Install
+
+```
+$ gem install tapp
+```
+
+## Usage
+
+``` ruby
+require 'tapp'
+
+'foo'.tapp   #=> `pp 'foo'` and return 'foo'
+'foo'.taputs #=> `puts 'foo'` and return 'foo'
+```
+
+See more examples in [spec/acceptance](https://github.com/esminc/tapp/tree/master/spec/acceptance) directory.
+
+## Configuration
+
+``` ruby
+Tapp.configure do |config|
+  config.default_printer = :awesome_print
+  config.report_caller   = true
+end
+```
+
+<table>
+  <tr>
+    <th>Key</th>
+    <th>Default</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td><code>default_printer</code></td>
+    <td><code>:pretty_print</code></td>
+    <td><a href="https://github.com/esminc/tapp/blob/master/spec/acceptance/default_printer.feature">default_printer.feature</a></td>
+  </tr>
+  <tr>
+    <td><code>report_caller</code></td>
+    <td><code>false</code></td>
+    <td><a href="https://github.com/esminc/tapp/blob/master/spec/acceptance/report_caller.feature">report_caller.feature</a></td>
+  </tr>
+</table>
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Contributors
+See https://github.com/esminc/tapp/contributors
+
+## Copyright
+Copyright &copy; 2010-2012 Keita Urashima. See LICENSE for details.

data/lib/tapp.rb

@@ -1,53 +1,22 @@
-require 'tapp/version'
+require 'tapp/configuration'
+require 'tapp/deprecated'
+require 'tapp/object_extension'
+require 'tapp/printer'
 
 module Tapp
-  class << self
-    attr_accessor :verbose
-
-    def report_called
-      return unless verbose
-      method_quoted = caller[0].split(':in').last.strip
-      puts "#{method_quoted} in #{caller[1]}"
-    end
-  end
-end
-
-class Object
-  def tapp
-    require 'pp'
-
-    Object.module_eval do
-      remove_method :tapp
+  extend Deprecated
 
-      def tapp
-        Tapp.report_called
-        tap { pp block_given? ? yield(self) : self }
-      end
+  class << self
+    def config
+      @config ||= Tapp::Configuration.new
     end
 
-    tapp
-  end
-
-  def taputs
-    Tapp.report_called
-    tap { puts block_given? ? yield(self) : self }
-  end
+    def configure
+      yield config
 
-  def taap
-    require 'ap'
-
-    Object.module_eval do
-      remove_method :taap
-
-      def taap
-        Tapp.report_called
-        tap { ap block_given? ? yield(self) : self }
-      end
+      config
     end
-
-    taap
-  rescue LoadError
-    warn "Sorry, you need to install awesome_print: `gem install awesome_print`"
   end
 end
 
+Object.__send__ :include, Tapp::ObjectExtension

data/lib/tapp/configuration.rb

@@ -0,0 +1,14 @@
+module Tapp
+  class Configuration
+    attr_accessor :default_printer, :report_caller
+
+    def initialize
+      reset
+    end
+
+    def reset
+      self.default_printer = :pretty_print
+      self.report_caller   = false
+    end
+  end
+end

data/lib/tapp/deprecated.rb

@@ -0,0 +1,15 @@
+module Tapp
+  module Deprecated
+    def verbose=(bool)
+      warn 'DEPRECATION WARNING: Tapp.verbose= is deprecated. Use Tapp.config.report_caller= instead.'
+
+      config.report_caller = bool
+    end
+
+    def verbose
+      warn 'DEPRECATION WARNING: Tapp.verbose is deprecated. Use Tapp.config.report_caller instead.'
+
+      config.report_caller
+    end
+  end
+end

data/lib/tapp/object_extension.rb

@@ -0,0 +1,24 @@
+require 'tapp/printer'
+require 'tapp/util'
+
+module Tapp
+  module ObjectExtension
+    def tapp(printer = Tapp.config.default_printer)
+      Tapp::Util.report_called if Tapp.config.report_caller
+
+      tap {
+        Tapp::Printer.instance(printer).print block_given? ? yield(self) : self
+      }
+    end
+
+    def taputs
+      tapp :puts
+    end
+
+    def taap
+      warn 'DEPRECATION WARNING: `taap` is deprecated. Set `Tapp.config.default_printer = :awesome_print` and use `tapp` instead.'
+
+      tapp :awesome_print
+    end
+  end
+end

data/lib/tapp/printer.rb

@@ -0,0 +1,30 @@
+require 'singleton'
+
+module Tapp
+  module Printer
+    autoload :AwesomePrint, 'tapp/printer/awesome_print'
+    autoload :PrettyPrint,  'tapp/printer/pretty_print'
+    autoload :Puts,         'tapp/printer/puts'
+
+    def self.instance(name)
+      case name
+      when :pretty_print
+        PrettyPrint.instance
+      when :puts
+        Puts.instance
+      when :awesome_print
+        AwesomePrint.instance
+      else
+        raise ArgumentError, "Unknown printer: #{name.inspect}"
+      end
+    end
+
+    class Base
+      include Singleton
+
+      def print(*args)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/tapp/printer/awesome_print.rb

@@ -0,0 +1,10 @@
+require 'tapp/printer'
+require 'ap'
+
+module Tapp::Printer
+  class AwesomePrint < Base
+    def print(*args)
+      ap *args
+    end
+  end
+end

data/lib/tapp/printer/pretty_print.rb

@@ -0,0 +1,10 @@
+require 'tapp/printer'
+require 'pp'
+
+module Tapp::Printer
+  class PrettyPrint < Base
+    def print(*args)
+      pp *args
+    end
+  end
+end

data/lib/tapp/printer/puts.rb

@@ -0,0 +1,9 @@
+require 'tapp/printer'
+
+module Tapp::Printer
+  class Puts < Base
+    def print(*args)
+      puts *args
+    end
+  end
+end

data/lib/tapp/util.rb

@@ -0,0 +1,17 @@
+require 'tapp'
+
+module Tapp
+  module Util
+    module_function
+
+    def report_called
+      inner, outer = caller.partition {|line|
+        line.include?('/lib/tapp')
+      }
+
+      method_quoted = inner.last.split(':in').last.strip
+
+      puts "#{method_quoted} in #{outer.first}"
+    end
+  end
+end

data/lib/tapp/version.rb

@@ -1,3 +1,3 @@
 module Tapp
-  VERSION = '1.3.1'
+  VERSION = '1.4.0'
 end

data/spec/acceptance/default_printer.feature

@@ -0,0 +1,14 @@
+Feature: config.default_printer
+  Scenario: set config.default_printer to :awesome_print and call tapp
+    Given I have the following code:
+    """
+    Tapp.config.default_printer = :awesome_print
+
+    'hoge'.tapp
+    """
+
+    When Ruby it
+    Then I should see:
+    """
+    "hoge"
+    """

data/spec/acceptance/report_caller.feature

@@ -0,0 +1,21 @@
+Feature: config.report_caller
+  Scenario: set config.report_caller to true and call tapp
+    Given a file named "hello.rb" with:
+    """
+    Tapp.config.report_caller = true
+
+    class Hello
+      def say
+        'hello'.tapp
+      end
+    end
+
+    Hello.new.say
+    """
+
+    When Ruby it
+    Then I should see:
+    """
+    `tapp' in hello.rb:5:in `say'
+    "hello"
+    """

data/spec/acceptance/tapp.feature

@@ -1,15 +1,11 @@
 Feature: Object#tapp
-
   Scenario: Call tapp within methods chain
     Given I have the following code:
     """
-    require 'tapp'
-
     (1..5).tapp.select(&:odd?).tapp.inject(&:+)
     """
 
     When Ruby it
-
     Then I should see:
     """
     1..5

data/spec/acceptance/taputs.feature

@@ -0,0 +1,16 @@
+Feature: Object#taputs
+  Scenario: Call taputs within methods chain
+    Given I have the following code:
+    """
+    (1..5).taputs.select(&:odd?).taputs.inject(&:+)
+    """
+
+    When Ruby it
+
+    Then I should see:
+    """
+    1..5
+    1
+    3
+    5
+    """

data/spec/spec_helper.rb

@@ -1,4 +1,9 @@
+require 'tapp'
+
+Dir[File.expand_path('../steps/**/*.rb', __FILE__)].each {|f| require f }
+
 RSpec.configure do |config|
-  Turnip::Config.step_dirs = 'spec/steps'
-  Turnip::StepLoader.load_steps
+  config.before do
+    Tapp.config.reset
+  end
 end

data/spec/steps/global_steps.rb

@@ -0,0 +1,28 @@
+step 'I have the following code:' do |code|
+  @code = code
+end
+
+step 'a file named :filename with:' do |filename, code|
+  @filename, @code = filename, code
+end
+
+step 'Ruby it' do
+  stdout = StringIO.new
+  $stdout = stdout
+
+  begin
+    if @filename
+      eval @code, binding, @filename, 1
+    else
+      eval @code
+    end
+  ensure
+    $stdout = STDOUT
+  end
+
+  @output = stdout.string.gsub(/\e\[0.*?m/, '').chop
+end
+
+step 'I should see:' do |output|
+  @output.should == output
+end

data/tapp.gemspec

@@ -17,5 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency 'thor'
+
   s.add_development_dependency 'turnip'
+  s.add_development_dependency 'awesome_print'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tapp
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000 Z
+date: 2012-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &12842600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *12842600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: turnip
-  requirement: &12842140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +37,28 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *12842140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: tap { pp self }
 email:
 - ursm@ursm.jp
@@ -47,15 +73,26 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - bin/tapp
 - lib/tapp.rb
 - lib/tapp/command.rb
+- lib/tapp/configuration.rb
+- lib/tapp/deprecated.rb
+- lib/tapp/object_extension.rb
+- lib/tapp/printer.rb
+- lib/tapp/printer/awesome_print.rb
+- lib/tapp/printer/pretty_print.rb
+- lib/tapp/printer/puts.rb
+- lib/tapp/util.rb
 - lib/tapp/version.rb
+- spec/acceptance/default_printer.feature
+- spec/acceptance/report_caller.feature
 - spec/acceptance/tapp.feature
+- spec/acceptance/taputs.feature
 - spec/spec_helper.rb
-- spec/steps/tapp_steps.rb
+- spec/steps/global_steps.rb
 - tapp.gemspec
 homepage: http://github.com/esminc/tapp
 licenses: []
@@ -77,11 +114,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: tap { pp self }
 test_files:
+- spec/acceptance/default_printer.feature
+- spec/acceptance/report_caller.feature
 - spec/acceptance/tapp.feature
+- spec/acceptance/taputs.feature
 - spec/spec_helper.rb
-- spec/steps/tapp_steps.rb
+- spec/steps/global_steps.rb

data/README.rdoc

@@ -1,49 +0,0 @@
-= tapp {<img src="https://secure.travis-ci.org/esminc/tapp.png?branch=master" alt="Build Status" />}[http://travis-ci.org/esminc/tapp]
-
-== Usage
-
-  $ gem install tapp
-
-  require 'tapp'
-  ...
-  foo bar.tapp     #=> pp bar
-  foo bar.taputs   #=> puts bar
-  foo bar.taap     #=> ap bar
-
-examples of use:
-
-  >> require 'tapp'
-  => true
-  >> (1..5).tapp.select(&:odd?).tapp.inject(&:+)
-  1..5
-  [1, 3, 5]
-  => 9
-  >> {:a => 1, :b => 2}.tapp(&:keys).tapp(&:values)
-  [:a, :b]
-  [1, 2]
-  => {:a=>1, :b=>2}
-
-=== Verbose Mode
-
-  >> Tapp::verbose = true
-  >> (1..5).tapp
-  `tapp' in (irb):2:in `irb_binding'
-  1..5
-  => 1..5
-
-== Note on Patches/Pull Requests
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Contributors
-see https://github.com/esminc/tapp/contributors
-
-== Copyright
-
-Copyright (c) 2010 Keita Urashima. See LICENSE for details.

data/spec/steps/tapp_steps.rb

@@ -1,18 +0,0 @@
-step "I have the following code:" do |code|
-  @code = code
-end
-
-step "Ruby it" do
-  stdout = StringIO.new
-  $stdout = stdout
-  begin
-    eval @code
-  ensure
-    $stdout = STDOUT
-  end
-  @output = stdout.string.chop
-end
-
-step "I should see:" do |output|
-  @output.should == output
-end