pry-macro 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa23fdc47bd8ace9361a778a65e06445a01d7296
-  data.tar.gz: 80e28a0aec12087d7286db13e4f3a6d28191cca0
+  metadata.gz: 177ddefdcbd1a0559fb3a4c515100cc9efd693ca
+  data.tar.gz: eaa0cf476554da956516491d56529022f06430ff
 SHA512:
-  metadata.gz: 906c94122071786ca8ec8653e6397b410c4ed3f7c0203f3bc9e3bad406b3ab5d4b01c1a87447af727a1a5f55a4de9171096e7f0cbeddf4f9257da94222efb65c
-  data.tar.gz: 1c7c0677a19d4a84841f9fc4400efe31dbc45c3f5382313996a3788bbd20e53ef83ce4d635da6a6c966fa8d04474fce030f13623a484849a2bb1c4b1ff8c36ff
+  metadata.gz: 071baa80cd6584b7b346038ec4fde4edbcfa2487e0325d9f09128d396cf7a76f6e156d7a1f95098f7f6b3cc9717931338adb1d8cc3107ea51904580119b796f8
+  data.tar.gz: 36e363f4bd719d7db88673a6f3281f3a48abba35e25fb4ca80a44aa3a9f130c5b4ceaf366689556023c31b2cf9f12fc02783e180300c0b297ed0ea68e7f33b6f

data/.rspec

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

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.md

@@ -5,7 +5,63 @@ Record command line actions for replaying.
 ## How is this different from play and history?
 
 You can dynamically make your own command sets and have them saved for
-later.
+later, as well as use pry commands.
+
+## Basic Usage
+
+Start recording:
+
+```ruby
+[1] pry(main)> record
+[2] pry(main)> 1
+=> 1
+[3] pry(main)> 'foo'
+=> "foo"
+[4] pry(main)> ls
+self.methods: inspect  to_s
+locals: _  __  _dir_  _ex_  _file_  _in_  _out_  _pry_
+```
+
+Stop the recording and name it:
+
+```ruby
+[5] pry(main)> stop
+Macro Name: testing
+```
+
+Run it like any other command:
+
+```ruby
+[6] pry(main)> testing
+=> 1
+=> "foo"
+self.methods: inspect  to_s
+locals: _  __  _dir_  _ex_  _file_  _in_  _out_  _pry_
+```
+
+Like it? You can save it and have it automatically append to your PryRC:
+
+```ruby
+[10] pry(main)> save-macro testing
+```
+
+...and here it is, nice and formatted:
+
+```ruby
+Pry::Commands.block_command 'testing', 'no description' do
+  _pry_.input = StringIO.new(
+    <<-MACRO.gsub(/^ {4,6}/, '')
+      1
+      'foo'
+      ls
+    MACRO
+  )
+end
+```
+
+## More Advanced Usage
+
+We're working on getting the Wiki up to date to cover more advanced usage.
 
 ## Why?
 
@@ -20,13 +76,9 @@ later.
 The possibilities here are endless. Make your own command sets as you
 REPL along from what you've already written.
 
-## Auto Pilot
-
-Want to "live code" for a presentation? Set it on auto-pilot and let it
-code itself. Define a keystroke to "type" the next command and watch it
-go.
+## To do
 
-Why risk it when you can make it look like you're coding?
+Next step is finding out how to properly test Pry and getting RSPEC written up for this.
 
 ## Installation
 
@@ -42,13 +94,10 @@ Or install it yourself as:
 
     $ gem install pry-macro
 
-## Usage
-
-TODO: Write usage instructions here
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/pry-macro/fork )
+1. Fork it ( http://github.com/baweaver/pry-macro/fork )
 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`)

data/Rakefile

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

data/lib/pry-macro.rb

@@ -7,6 +7,12 @@ module PryMacro
 
   Commands = Pry::CommandSet.new do
     create_command 'record', 'Starts a recording session' do
+      banner <<-BANNER
+        Usage: record
+
+        Starts recording a macro.
+      BANNER
+
       def process
         # Define a few extra ivars on the current pry session so we can persist some state to use
         unless _pry_.instance_variable_defined?(:@record_stack)
@@ -21,6 +27,14 @@ module PryMacro
     end
 
     create_command 'stop', 'Stops a recording session, and saves a macro' do
+      banner <<-BANNER
+        Usage: stop [-n name] [-d desc]
+
+        Stops recording a macro, loads the command, and caches it for later saving if
+        desired. If no name is provided, user will be prompted for one. Descriptions 
+        may be provided, but will default to 'no description'
+      BANNER
+
       def setup
         if !_pry_.instance_variable_defined?(:@record_stack) && _pry_.record_stack.empty?
           raise 'Cannot stop recording when no recorder is running'
@@ -35,12 +49,21 @@ module PryMacro
              .to_a
              .last(session_end - session_begin - 1)
              .reduce(StringIO.new) { |io, item| io.puts(item); io }
+      end
 
-        # Have to have a name to execute this later
-        @name = ask('Macro Name: ')
+      def options(opts)
+        opts.on :n, :name, "Name to use to define the macro",
+                           optional_argument: true, as: String
+        opts.on :d, :desc, "Description of the macro",
+                           optional_argument: true, as: String
+        opts.on :v, :verbose, "Echoes back the macro definition"
       end
 
       def process
+        # Have to have a name to execute this later
+        name = opts[:n] || ask('Macro Name: ')
+        desc = opts[:d] || 'no description'
+
         history_lines = @history.string.lines.map { |s| "      #{s}"}.join.chomp.tap { |h|
           h.sub!(/^ {6}/,'') # First line won't need the spacing
         }
@@ -48,7 +71,7 @@ module PryMacro
         # Save the command into a string, and make it look decent
         # Tinge of a heredocs hack
         command_string = <<-COMMAND_STRING.gsub(/^ {10}/, '')
-          Pry::Commands.block_command '#{@name}', 'no description' do
+          Pry::Commands.block_command '#{name}', '#{desc}' do
             _pry_.input = StringIO.new(
               <<-MACRO.gsub(/^ {4,6}/, '')
                 #{history_lines}
@@ -57,7 +80,7 @@ module PryMacro
           end
         COMMAND_STRING
 
-        puts command_string
+        puts command_string if opts[:v]
 
         # ...so that we can save the contents for saving later (optional)
         _pry_.macro_strings << MacroString.new(@name, command_string)
@@ -66,22 +89,31 @@ module PryMacro
       end
     end
 
-    create_command 'save_macro', 'Saves a named macro to your .pryrc file on the tail end' do
-      def options(opt)
-        # Options for later:
-        # -p --path : path to save in
-        # -n --name : name of the command (override)
-        # -d --desc : description of the command
+    create_command 'save-macro', 'Saves a named macro to your .pryrc file on the tail end' do
+      banner <<-BANNER
+        Usage: save-macro [-p path]
+
+        Saves a cached macro to your ~/.pryrc or the path specified.
+      BANNER
+
+      def options(opts)
+        opts.on :p, :path, "Pathname to save macro in",
+                           optional_argument: true, as: String
       end
 
       def process
         raise 'No Macros are defined!' unless _pry_.instance_variable_defined?(:@macro_strings)
-        @macro = _pry_.macro_strings.find(
-          -> { raise "Command #{args.first} not found!" } # If nothing is found, raise the error
-        ) { |macro| macro.name == args.first }
+        raise 'Invalid path!' if opts[:p] && !Dir[opts[:p]]
+        raise 'Must specify the macro to save!' if args.empty?
+
+        path  = opts[:p] || Dir.home
+        macro = _pry_.macro_strings.find(
+          # If nothing is found, raise the error
+          -> { raise "Command #{args.first} not found!" }
+        ) { |m| m.name == args.first }
 
         # Append the Pryrc with the macro, leaving blank lines
-        File.open(File.join(Dir.home, '.pryrc'), 'a') { |f| f.puts '', @macro.command, '' }
+        File.open(File.join(path, '.pryrc'), 'a') { |f| f.puts '', macro.command, '' }
       end
     end
   end

data/lib/pry-macro/version.rb

@@ -1,3 +1,3 @@
 module PryMacro
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/pry-macro.gemspec

@@ -9,7 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Brandon Weaver"]
   spec.email         = ["keystonelemur@gmail.com"]
   spec.summary       = %q{Macros for Pry}
-  spec.homepage      = ""
+  spec.description   = %q{Macro Recording and Saving functionality for pry}
+  spec.homepage      = "https://github.com/baweaver/pry-macro"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -19,6 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
 
   spec.add_runtime_dependency "pry"
   spec.add_runtime_dependency "pry-plus"

data/spec/pry-macro_spec.rb

@@ -0,0 +1,82 @@
+# require 'spec_helper'
+
+# Need to find a more effective way to spec this all out. There are some nuances I haven't quite
+# grasped in mocking out pry commands. As soon as I can figure out the last few bits this will
+# get built on Travis and put under a bit more process.
+
+# describe 'PryMacro' do
+#   before :all do
+#     @str_output = StringIO.new
+
+#     @t = pry_tester do
+#       def insert_nil_input
+#         @pry.update_input_history(nil)
+#       end
+
+#       def last_exception=(e)
+#         @pry.last_exception = e
+#       end
+#     end
+
+#     _pry_.stub(
+#       input: @t.pry.input
+#     )
+
+#     @t.eval 'record'
+#     @t.pry.input = StringIO.new('1')
+#     binding.pry
+#     @t.eval 'stop -n test_macro'
+#   end
+
+#   describe '#record' do
+#     it 'sets instance variables on @t.pry' do
+#       expect(@t.pry.instance_variable_defined?(:@record_stack)).to be_true
+#       expect(@t.pry.instance_variable_defined?(:@macro_strings)).to be_true
+#     end
+#   end
+
+#   describe '#stop' do
+#     context 'Record stack is empty' do
+#       before { @t.pry.stub(record_stack: []) }
+
+#       it 'raises an error' do
+#         expect { @t.eval 'stop' }.to raise_error()
+#       end
+#     end
+
+#     context 'Record stack present' do
+#       it 'pops the start from the record stack' do
+#         expect(@t.pry.record_stack.empty?).to be_true
+#       end
+
+#       it 'creates a the macro' do
+#         expect(@t.eval 'test_macro').to be(1)
+#       end
+
+#       it 'caches the macro in @macro_strings' do
+#         expect(@t.pry.macro_strings.first.name).to be ('test_macro')
+#       end
+#     end
+#   end
+
+  # describe '#save-macro' do
+  #   context 'No Macros are defined' do
+  #     before { @t.pry.stub(macro_strings: [])}
+
+  #     it 'raises an error' do
+  #       expect { @t.eval 'save' }.to raise_error()
+  #     end
+  #   end
+
+  #   context 'Macros are defined' do
+  #     it 'saves the macro to .pryrc' do
+  #       fake_file = StringIO.new
+  #       File.stub(puts: fake_file)
+
+  #       @t.eval 'save'
+
+  #       expect(fake_file.string).to_not be_empty
+  #     end
+  #   end
+  # end
+# end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'pry/test/helper'
+require 'pry-macro'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pry-macro
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Brandon Weaver
@@ -38,6 +38,48 @@ dependencies:
     - - '>='
       - !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: guard
+  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: guard-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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +122,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description: Macro Recording and Saving functionality for pry
 email:
 - keystonelemur@gmail.com
 executables: []
@@ -88,14 +130,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/pry-macro.rb
 - lib/pry-macro/version.rb
 - pry-macro.gemspec
-homepage: ''
+- spec/pry-macro_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/baweaver/pry-macro
 licenses:
 - MIT
 metadata: {}
@@ -119,5 +166,7 @@ rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Macros for Pry
-test_files: []
+test_files:
+- spec/pry-macro_spec.rb
+- spec/spec_helper.rb
 has_rdoc: