duct 0.0.0 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f20e93081ed84a57df274ce99797d4aba409c43e
+  data.tar.gz: f075c2159472292ee1cb0f6cae1927b06cb2a8a8
+SHA512:
+  metadata.gz: 0b8619568bf00163da213ee8bd4ea5480d582101b9dcc7916fb9a4cca4032126682f27488b23694f2897d274b8dd8a0710adea06ee9ae4c7616ec0c8740c4fc8
+  data.tar.gz: 76cde8fe434e75b2101bf13d92cc3a96d095141aeb08a6cd78017c6f09d56d5f7c6627660ef8f8810638a62df88d8f5d079f79c6b6c3f198e1ca80a8130aaa67

data/README.md

@@ -1,24 +1,84 @@
 # Duct
 
-TODO: Write a gem description
+![Duct Tape, By Evan-Amos, via Wikimedia Commons](http://upload.wikimedia.org/wikipedia/commons/thumb/8/89/Duct-tape.jpg/256px-Duct-tape.jpg)
 
-## Installation
+Duct is a small wrapper around [bundler](http://bundler.io/). It allows you to embed a Gemfile in a script.
 
-Add this line to your application's Gemfile:
+## Usecase
 
-    gem 'duct'
+Sometimes you write small scripts to do different tasks. Sometimes you store them for future use. Sometimes those
+scripts use some gems to do their task (database access, web requests, whatever). So, after some time, you reuse them
+and you don't know which version of which gems did you use and you can run into trouble (like with full fledged apps in
+the pre-bundler days). That's when you do the obvious workaround: create a directory to store the script together with a
+`Gemfile` and a `Gemfile.lock`.
 
-And then execute:
+That's a good solution but feels a bit overkill. Duct allows you to embed the `Gemfile` (and the `Gemfile.lock`) in the same file, so it's a single file to store together with others, as a [gist](https://gist.github.com/), etc.
 
-    $ bundle
+## Installation
 
-Or install it yourself as:
+Duct is a command line utility, so just install it via rubygems:
 
     $ gem install duct
 
 ## Usage
 
-TODO: Write usage instructions here
+First, write your `Gemfile` in the data section of your script, after the `__END__` label, and after a `@@ Gemfile`
+label:
+
+```ruby
+require 'sinatra'
+
+get '/' do
+  'Hello, world!'
+end
+
+__END__
+@@ Gemfile
+source 'https://rubygems.org'
+
+gem 'sinatra'
+```
+
+(this is very much like the [Sinatra inline templates](http://www.sinatrarb.com/intro.html#Inline%20Templates), and can
+in fact be combined with them).
+
+Then, run the script using the `duct` command:
+
+```
+$ duct my_script.rb
+```
+
+The default action is running the script, checking previously whether dependencies are met, and installing them (via
+`bundle install`) if needed. Notice that your script data section will be updated with a section for the `Gemfile.lock`
+if needed (beware of conflicts with your editor while you develop the script).
+
+### Passing parameters
+
+If your script expects parameters, just pass them after the filename:
+
+```
+$ duct my_script.rb param1 param2
+```
+
+### Updating the bundle
+
+You can run any of the `bundle` subcommands (mainly `update`, with or without a gem name, but also `outdated`, `check`,
+`list`, `show` and [all the rest](http://bundler.io/v1.5/man/bundle.1.html#PRIMARY-COMMANDS)) passing them *before* the
+filename:
+
+```
+$ duct update sinatra my_script.rb
+```
+
+Remember that updating the bundle will update the `Gemfile.lock` section in your script, so remember to save those
+changes.
+
+### Using the script data
+
+Duct will ignore the part of the data section **before** the first `@@ XYZ` label (and the sections with other labels
+than `@@ Gemfile` and `@@ Gemfile.lock`, as it was mentioned for the Sinatra inline templates case), so you can still
+use that ruby feature, but you will need to make sure your script handles and ignores the `Gemfile` and `Gemfile.lock`
+sections, of course.
 
 ## Contributing
 
@@ -27,3 +87,7 @@ TODO: Write usage instructions here
 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
+
+## License
+
+Released under the MIT License, Copyright (c) 2014 Sergio Gil.

data/Rakefile

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

data/bin/duct

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'duct/cli'
+
+Duct::Cli.new(ARGV.dup).run

data/duct.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Duct::VERSION
   spec.authors       = ["Sergio Gil"]
   spec.email         = ["sgilperez@gmail.com"]
-  spec.description   = %q{duct tape}
-  spec.summary       = %q{duct tape}
+  spec.description   = %q{Embeds a Gemfile in a script}
+  spec.summary       = %q{Embeds a Gemfile in a script}
   spec.homepage      = "https://github.com/porras/duct"
   spec.license       = "MIT"
 
@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "bundler"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/examples/sinatra.rb

@@ -0,0 +1,32 @@
+require 'sinatra'
+
+get '/' do
+  @name = params[:name] || 'world'
+  erb :index
+end
+
+__END__
+@@ Gemfile
+source 'https://rubygems.org'
+
+gem 'sinatra'
+@@ Gemfile.lock
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rack (1.5.2)
+    rack-protection (1.5.1)
+      rack
+    sinatra (1.4.4)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    tilt (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  sinatra
+@@ index
+Hello, <%= @name %>!

data/lib/duct.rb

@@ -1,5 +1,3 @@
-require "duct/version"
-
-module Duct
-  # Your code goes here...
-end
+require 'duct/version'
+require 'duct/runner'
+require 'duct/cli'

data/lib/duct/cli.rb

@@ -0,0 +1,58 @@
+require 'duct/runner'
+
+module Duct
+  class Cli
+    BUNDLER_COMMANDS = %w{
+      update
+      check
+      list
+      show
+      outdated
+      console
+      open
+      viz
+    }
+
+    USAGE = %Q{Commands:
+  duct myscript.rb [param1 param2] # Installs bundle included in myscript.rb if needed and
+                                   # runs myscript with optional parameters.
+  duct update sinatra myscript.rb  # Runs specified bundler command on the bundled included
+                                   # in myscript, passing the additional parameters. Available
+                                   # commands: #{BUNDLER_COMMANDS.join(', ')}.
+                                   # Run bundle help for more info.}
+
+    def initialize(args)
+      @args = args
+    end
+
+    def filename
+      command ? @args.last : @args.first
+    end
+
+    def command
+      @args[0..-2].join(' ') if BUNDLER_COMMANDS.include?(@args.first)
+    end
+
+    def params
+      command ? [] : @args[1..-1]
+    end
+
+    def error?
+      !(command || filename)
+    end
+
+    def run
+      if error?
+        puts(USAGE)
+        exit(-1)
+      end
+      runner.run
+    end
+
+    private
+
+    def runner
+      @runner ||= Duct::Runner.new(self)
+    end
+  end
+end

data/lib/duct/runner.rb

@@ -0,0 +1,59 @@
+require 'tmpdir'
+require 'stringio'
+
+module Duct
+  class Runner
+    def initialize(config)
+      @config = config
+      @script, @data = File.read(@config.filename).split(/^__END__$/, 2)
+      @preamble = @data.split(/^@@\s*(.*\S)\s*$/, 2).first
+    end
+
+    def run
+      copy_embedded_files
+      system "BUNDLE_GEMFILE=#{tempdir}/Gemfile bundle #{@config.command}"
+      update_embedded_files
+      exec "BUNDLE_GEMFILE=#{tempdir}/Gemfile bundle exec ruby #{@config.filename} #{@config.params.join(' ')}; rm -rf #{tempdir}" unless @config.command
+    end
+
+    private
+
+    def copy_embedded_files
+      embedded_files.each do |file, contents|
+        IO.write("#{tempdir}/#{file}", contents)
+      end
+    end
+
+    def update_embedded_files
+      contents = @script.dup
+
+      contents << "__END__"
+      contents << @preamble
+
+      Dir.glob("#{tempdir}/*") do |filename|
+        contents << "@@ #{File.basename(filename)}\n"
+        contents << File.read(filename)
+      end
+
+      IO.write(@config.filename, contents)
+    end
+
+    def embedded_files
+      @embedded_files ||= {}.tap do |files|
+        file = nil
+        @data.each_line do |line|
+          if line =~ /^@@\s*(.*\S)\s*$/
+            file = ''
+            files[$1.to_sym] = file
+          elsif file
+            file << line
+          end
+        end
+      end
+    end
+
+    def tempdir
+      @tempdir ||= Dir.mktmpdir
+    end
+  end
+end

data/lib/duct/version.rb

@@ -1,3 +1,3 @@
 module Duct
-  VERSION = "0.0.0"
+  VERSION = "0.1.0"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.color_enabled = true
+end

data/spec/unit/cli_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'duct/cli'
+
+describe Duct::Cli do
+  subject { Duct::Cli.new(argv) }
+
+  context 'just filename' do
+    let(:argv) { ['myscript.rb'] }
+
+    its(:filename) { should == 'myscript.rb' }
+    its(:command)  { should be_nil }
+    its(:params)   { should be_empty }
+    its(:error?)   { should be_false }
+  end
+
+  context 'filename and params' do
+    let(:argv) { ['myscript.rb', 'param1', 'param2'] }
+
+    its(:filename) { should == 'myscript.rb' }
+    its(:command)  { should be_nil }
+    its(:params)   { should == ['param1', 'param2'] }
+    its(:error?)   { should be_false }
+  end
+
+  context 'command and filename' do
+    let(:argv) { ['update', 'myscript.rb'] }
+
+    its(:filename) { should == 'myscript.rb' }
+    its(:command)  { should == 'update' }
+    its(:params)   { should be_empty }
+    its(:error?)   { should be_false }
+
+    context 'with params for the command' do
+      let(:argv) { ['update', 'sinatra', 'myscript.rb'] }
+
+      its(:filename) { should == 'myscript.rb' }
+      its(:command)  { should == 'update sinatra' }
+      its(:params)   { should be_empty }
+      its(:error?)   { should be_false }
+    end
+  end
+
+  context 'errors' do
+    context 'nothing' do
+      let(:argv) { [] }
+
+      its(:error?) { should be_true }
+    end
+  end
+end

metadata

@@ -1,20 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: duct
 version: !ruby/object:Gem::Version
-  version: 0.0.0
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Sergio Gil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-05 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +34,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,23 +41,36 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     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
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: duct tape
+description: Embeds a Gemfile in a script
 email:
 - sgilperez@gmail.com
-executables: []
+executables:
+- duct
 extensions: []
 extra_rdoc_files: []
 files:
@@ -55,33 +79,39 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/duct
 - duct.gemspec
+- examples/sinatra.rb
 - lib/duct.rb
+- lib/duct/cli.rb
+- lib/duct/runner.rb
 - lib/duct/version.rb
+- spec/spec_helper.rb
+- spec/unit/cli_spec.rb
 homepage: https://github.com/porras/duct
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
-summary: duct tape
-test_files: []
-has_rdoc: 
+specification_version: 4
+summary: Embeds a Gemfile in a script
+test_files:
+- spec/spec_helper.rb
+- spec/unit/cli_spec.rb