gisture 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5046586f68d4e3fc48763e84ca611fcefacaa09b
-  data.tar.gz: 176944e2861cdbad46bf0646acc7cb67ee229826
+  metadata.gz: 562752af4ac2795824b1624d31fa1d4140198eab
+  data.tar.gz: c70c205d2041bef77bd7f030cb8831a449917751
 SHA512:
-  metadata.gz: e936a72c5a01526ccc17e82d914386c5ed1c75787beb8d556e895d04a778210fd05f88dc6530cdd289df9e69015598650e6664317d75a15133a690d4d442a1b0
-  data.tar.gz: 47d16ac5491f8369dabc7ae4ad6bd7fddd75ae113941e2d23720952c7bf1eda1a0328cd14251695ddef0ba46f6ec1c09013f4acbcd70b0ed67838082a1081226
+  metadata.gz: 6e625ab43f9d65f19e0261b29998634c1aa9d5d0d55bd447c4eaabe2d239dbbfd869c7c1143bb16a0ef3e67cef3abafdb3ccbe205142f29efc6216e805f78066
+  data.tar.gz: 74d045d2265805b027b5c15908e82d4fb798d22856f471168a75786919d60a537ee58e3cfd8a0589af784c9a4796e39589b39c2fcdfeb4d3388e97167b43a0af

data/bin/gisture

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'gisture'
+require 'gisture/cli'
+
+Gisture::CLI.start(*ARGV)

data/lib/gisture/cli.rb

@@ -0,0 +1,10 @@
+require 'kommand/cli'
+require 'gisture/version'
+require 'gisture/commands'
+
+module Gisture
+  class CLI < Kommand::CLI
+    self.binary = 'gisture'
+    self.version = Gisture::VERSION
+  end
+end

data/lib/gisture/cloned_file.rb

@@ -0,0 +1,51 @@
+module Gisture
+  class ClonedFile < File
+    attr_reader :clone_path
+
+    def require!(*args, &block)
+      @cwd = Dir.pwd
+      Dir.chdir clone_path
+      super
+    ensure
+      Dir.chdir @cwd
+    end
+
+    def load!(*args, &block)
+      @cwd = Dir.pwd
+      Dir.chdir clone_path
+      super
+    ensure
+      Dir.chdir @cwd
+    end
+
+    def eval!(*args, &block)
+      @cwd = Dir.pwd
+      Dir.chdir clone_path
+      super
+    ensure
+      Dir.chdir @cwd
+    end
+
+    def exec!(*args, &block)
+      @cwd = Dir.pwd
+      Dir.chdir clone_path
+      super
+    ensure
+      Dir.chdir @cwd
+    end
+
+    def unlink_tempfile
+      false
+    end
+
+    protected
+
+    def initialize(clone_path, file_path, basename: nil, strategy: nil)
+      path = ::File.join(clone_path, file_path)
+      @clone_path = clone_path
+      @tempfile = ::File.new(path)
+      file_hash = Hashie::Mash.new({path: path, filename: ::File.basename(path), content: tempfile.read})
+      super(file_hash, basename: basename, strategy: strategy)
+    end
+  end
+end

data/lib/gisture/commands/gist/run.rb

@@ -0,0 +1,76 @@
+require 'kommand/commands'
+
+module Gisture
+  module Commands
+    module Gist
+      class Run
+        include Kommand::Commands::Command
+
+        command_name 'gist:run'
+        command_summary "Run a gist directly from the command line"
+        valid_argument Kommand::Scripts::Argument.new("-f, --filename", summary: "Specify a filename if your gist has multiple files")
+        valid_argument Kommand::Scripts::Argument.new("-s, --strategy", summary: "Execution strategy, defaults to 'eval'")
+        valid_argument Kommand::Scripts::Argument.new("-e, --evaluator", summary: "Use a custom evaluator class, only applies to 'eval' strategy")
+        valid_argument Kommand::Scripts::Argument.new("-c, --clone", summary: "Clone the gist into a local tmp path and run from that working dir")
+        validate_arguments false
+
+        class << self
+          def usage
+            puts "usage: #{Kommand.kommand} #{command_name} GIST_ID_OR_URL #{valid_arguments.to_s}"
+            unless valid_arguments.empty?
+              puts
+              puts "Arguments:"
+              puts valid_arguments.to_help
+            end
+          end
+        end
+
+        def run
+          clone? ? gist.clone! : gist.destroy_clone!
+
+          result = gist.run!
+
+          if strategy == :exec
+            puts result
+          else
+            result
+          end
+        end
+
+        protected
+
+        def gist
+          @gist = Gisture.gist(gist_url, strategy: strategy, filename: filename)
+        end
+
+        def gist_url
+          @gist_url ||= arguments.unnamed.first.value
+        end
+
+        def strategy
+          @strategy ||= begin
+            strat = arguments.get(:strategy) || 'eval'
+            if strat == 'eval'
+              {eval: evaluator}
+            else
+              strat.to_sym
+            end
+          end
+        end
+
+        def evaluator
+          @evaluator ||= eval(arguments.get(:evaluator) || 'Gisture::Evaluator')
+        end
+
+        def filename
+          @filename ||= arguments.get(:filename)
+        end
+
+        def clone?
+          arguments.arg?(:clone)
+        end
+
+      end
+    end
+  end
+end

data/lib/gisture/commands/repo/run.rb

@@ -0,0 +1,82 @@
+require 'kommand/commands'
+
+module Gisture
+  module Commands
+    module Repo
+      class Run
+        include Kommand::Commands::Command
+
+        command_name 'repo:run'
+        command_summary "Run a repo file directly from the command line"
+        valid_argument Kommand::Scripts::Argument.new("-f, --filename", summary: "Specify a filename if it's not included in the repo URL")
+        valid_argument Kommand::Scripts::Argument.new("-s, --strategy", summary: "Execution strategy, defaults to 'eval'")
+        valid_argument Kommand::Scripts::Argument.new("-e, --evaluator", summary: "Use a custom evaluator class, only applies to 'eval' strategy")
+        valid_argument Kommand::Scripts::Argument.new("-c, --clone", summary: "Clone the repo into a local tmp path and run from that working dir")
+        validate_arguments false
+
+        class << self
+          def usage
+            puts "usage: #{Kommand.kommand} #{command_name} GIST_ID_OR_URL #{valid_arguments.to_s}"
+            unless valid_arguments.empty?
+              puts
+              puts "Arguments:"
+              puts valid_arguments.to_help
+            end
+          end
+        end
+
+        def run
+          clone? ? repo.clone! : repo.destroy_clone!
+
+          result = file.run!
+
+          if strategy == :exec
+            puts result
+          else
+            result
+          end
+        end
+
+        protected
+
+        def file
+          @file ||= repo.file((repo_url[1] || filename), strategy: strategy)
+        end
+
+        def repo
+          @repo ||= Gisture.repo(repo_url[0])
+        end
+
+        def repo_url
+          Gisture::Repo.parse_file_url(arguments.unnamed.first.value)
+        rescue
+          [Gisture::Repo.parse_repo_url(arguments.unnamed.first.value).join('/')]
+        end
+
+        def strategy
+          @strategy ||= begin
+            strat = arguments.get(:strategy) || 'eval'
+            if strat == 'eval'
+              {eval: evaluator}
+            else
+              strat.to_sym
+            end
+          end
+        end
+
+        def evaluator
+          @evaluator ||= eval(arguments.get(:evaluator) || 'Gisture::Evaluator')
+        end
+
+        def filename
+          @filename ||= arguments.get(:filename)
+        end
+
+        def clone?
+          arguments.arg?(:clone)
+        end
+
+      end
+    end
+  end
+end

data/lib/gisture/commands.rb

@@ -0,0 +1,7 @@
+require 'gisture/commands/gist/run'
+require 'gisture/commands/repo/run'
+
+module Gisture
+  module Commands
+  end
+end

data/lib/gisture/file.rb

@@ -4,47 +4,88 @@ module Gisture
   class File
     attr_reader :file, :basename, :strategy
 
-    STRATEGIES = [:eval, :load, :require]
+    STRATEGIES = [:eval, :exec, :load, :require]
 
-    def run!(&block)
-      send "#{strategy}!".to_sym, &block
+    def run!(*args, &block)
+      strat_key = strategy
+      if strategy.respond_to?(:keys)
+        strat_key = strategy.keys.first
+        if strategy[strat_key].is_a?(Array)
+          args = args.concat(strategy[strat_key])
+        else
+          args << strategy[strat_key]
+        end
+      end
+
+      send "#{strat_key}!".to_sym, *args, &block
     end
 
-    def require!(&block)
+    def require!(*args, &block)
       Gisture.logger.info "[gisture] Running #{basename}/#{file.path || file.filename} via the :require strategy"
       required = require tempfile.path
       unlink_tempfile
       block_given? ? yield : required
     end
 
-    def load!(&block)
+    def load!(*args, &block)
       Gisture.logger.info "[gisture] Running #{basename}/#{file.path || file.filename} via the :load strategy"
       loaded = load tempfile.path
       unlink_tempfile
       block_given? ? yield : loaded
     end
 
-    def eval!(&block)
+    def eval!(*args, &block)
       Gisture.logger.info "[gisture] Running #{basename}/#{file.path || file.filename} via the :eval strategy"
-      clean_room = Evaluator.new(file.content)
-      clean_room.instance_eval &block if block_given?
-      clean_room
+      args << Gisture::Evaluator
+      klass = args.first
+      evaluator = klass.new(file.content)
+      evaluator.instance_eval &block if block_given?
+      evaluator
+    end
+
+    def exec!(*args, &block)
+      Gisture.logger.info "[gisture] Running #{basename}/#{file.path || file.filename} via the :exec strategy"
+
+      # map nils to file path in args to allow easily inserting the filepath wherever
+      # makes sense in your executable arguments (i.e. 'ruby', '-v', nil, '--script-arg')
+      args.map! { |arg| arg.nil? ? tempfile.path : arg }
+
+      # attempt to apply a default interpreter if nothing was provided
+      # TODO create a legit map of default interpreter args and apply it
+      args = ['ruby'] if args.empty? && extname == '.rb'
+      args = ['node'] if args.empty? && extname == '.js'
+
+      # append the filepath if it was not inserted into the args already
+      args << tempfile.path unless args.include?(tempfile.path)
+
+      # make file executable if we're just invoking it directly
+      ::File.chmod(0744, tempfile.path) if args.length == 1
+
+      executed = `#{args.join(' ')}`.strip
+      block_given? ? yield : executed
     end
 
     def strategy=(strat)
-      raise ArgumentError, "Invalid strategy '#{strat}'. Must be one of #{STRATEGIES.join(', ')}" unless STRATEGIES.include?(strat.to_sym)
-      @strategy = strat.to_sym
+      strat_key = strat
+      strat_key = strat.keys.first if strat.respond_to?(:keys)
+      raise ArgumentError, "Invalid strategy '#{strat_key}'. Must be one of #{STRATEGIES.join(', ')}" unless STRATEGIES.include?(strat_key.to_sym)
+      @strategy = strat
     end
 
     def tempfile
       @tempfile ||= begin
-        tmpfile = Tempfile.new([basename.to_s.gsub(/\//, '-'), file.filename, ::File.extname(file.filename)].compact, Gisture.configuration.tmpdir)
+        tmpfile = Tempfile.new([basename.to_s.gsub(/\//, '-'), file.filename, extname].compact, Gisture.configuration.tmpdir)
         tmpfile.write(file.content)
         tmpfile.close
         tmpfile
       end
     end
 
+    def extname
+      @extname ||= ::File.extname(file.filename)
+    end
+    alias_method :extension, :extname
+
     def unlink_tempfile
       tempfile.unlink
       @tempfile = nil

data/lib/gisture/gist.rb

@@ -2,7 +2,6 @@ module Gisture
   class Gist
     attr_reader :filename, :gist_id, :strategy, :version
 
-    STRATEGIES = [:eval, :load, :require]
     GIST_URL_REGEX = /\Ahttp.+([0-9a-f]{20,20})\/?\Z/
     GIST_URL_WITH_VERSION_REGEX = /\Ahttp.+([0-9a-f]{20,20})\/([0-9a-f]{40,40})\/?\Z/
 
@@ -10,27 +9,28 @@ module Gisture
       new(gist, strategy: strategy, filename: filename, version: version).run!(&block)
     end
 
-    def run!(&block)
-      send "#{strategy}!".to_sym, &block
+    def run!(*args, &block)
+      file.run! *args, &block
     end
 
-    def require!(&block)
-      file.require! &block
+    def require!(*args, &block)
+      file.require! *args, &block
     end
 
-    def load!(&block)
-      file.load! &block
+    def load!(*args, &block)
+      file.load! *args, &block
     end
 
-    def eval!(&block)
-      file.eval! &block
+    def eval!(*args, &block)
+      file.eval! *args, &block
+    end
+
+    def exec!(*args, &block)
+      file.exec! *args, &block
     end
 
     def github
-      @github ||= begin
-        github_config = Hash[Gisture::GITHUB_CONFIG_OPTS.map { |key| [key, Gisture.configuration.send(key)] }]
-        Github.new(github_config)
-      end
+      @github ||= Github.new(Gisture.configuration.github.to_h)
     end
 
     def gist
@@ -45,22 +45,65 @@ module Gisture
       end
     end
 
-    def file
-      return @file unless @file.nil?
+    def file(fname=nil)
+      fname ||= filename
+      fname ||= gist.files.first[1].filename
+      raise ArgumentError, "The filename '#{fname}' was not found in the list of files for the gist '#{gist_id}'" if gist.files[fname].nil?
 
-      if gist.files.count > 1 && !filename.nil?
-        @file = Gisture::File.new(gist.files[filename], basename: "#{gist.owner.login}/#{gist_id}", strategy: strategy)
-        raise ArgumentError, "The filename '#{filename}' was not found in the list of files for the gist '#{gist_id}'" if @file.nil?
+      if cloned?
+        Gisture::ClonedFile.new(clone_path, fname, basename: "#{owner}/#{gist_id}", strategy: strategy)
       else
-        @file = Gisture::File.new(gist.files.first[1], basename: "#{gist.owner.login}/#{gist_id}", strategy: strategy)
+        Gisture::File.new(gist.files[fname], basename: "#{owner}/#{gist_id}", strategy: strategy)
+      end
+    end
+
+    def owner
+      gist.owner.login
+    end
+
+    def clone_path
+      @clone_path ||= ::File.join(Gisture.configuration.tmpdir, owner, gist_id)
+    end
+
+    def clone!(&block)
+      destroy_clone!
+      clone
+    end
+
+    def clone(&block)
+      return self if cloned?
+
+      Gisture.logger.info "[gisture] Cloning #{owner}/#{gist_id} into #{clone_path}"
+
+      repo_url = "https://#{Gisture.configuration.github.auth_str}@gist.github.com/#{gist_id}.git"
+      Git.clone(repo_url, gist_id, path: ::File.dirname(clone_path))
+
+      FileUtils.rm_rf("#{clone_path}/.git")
+      ::File.write("#{clone_path}/.gisture", Time.now.to_i.to_s)
+
+      if block_given?
+        instance_eval &block
+        destroy_clone!
       end
 
-      @file
+      self
+    end
+
+    def destroy_clone!
+      FileUtils.rm_rf(clone_path)
+    end
+
+    def cloned?
+      ::File.read("#{clone_path}/.gisture").strip
+    rescue
+      false
     end
 
     def strategy=(strat)
-      raise ArgumentError, "Invalid strategy '#{strat}'. Must be one of #{STRATEGIES.join(', ')}" unless STRATEGIES.include?(strat.to_sym)
-      @strategy = strat.to_sym
+      strat_key = strat
+      strat_key = strat.keys.first if strat.respond_to?(:keys)
+      raise ArgumentError, "Invalid strategy '#{strat_key}'. Must be one of #{File::STRATEGIES.join(', ')}" unless File::STRATEGIES.include?(strat_key.to_sym)
+      @strategy = strat
     end
 
     def to_h

data/lib/gisture/repo.rb

@@ -28,9 +28,7 @@ module Gisture
     end
 
     def github
-      @github ||= begin
-        Github.new(github_config)
-      end
+      @github ||= Github.new(Gisture.configuration.github.to_h)
     end
 
     def repo
@@ -38,25 +36,61 @@ module Gisture
     end
 
     def file(path, strategy: nil)
-      file = github.repos.contents.get(user: owner, repo: project, path: path).body
-      file['filename'] = ::File.basename(file['path'])
-      file['content'] = Base64.decode64(file['content'])
-      Gisture::File.new(file, basename: "#{owner}/#{project}", strategy: strategy)
+      if cloned?
+        Gisture::ClonedFile.new(clone_path, path, basename: "#{owner}/#{project}", strategy: strategy)
+      else
+        file = github.repos.contents.get(user: owner, repo: project, path: path).body
+        Gisture::RepoFile.new(file, basename: "#{owner}/#{project}", strategy: strategy)
+      end
     end
 
     def run!(path, strategy: nil, &block)
       file(path, strategy: strategy).run!(&block)
     end
 
+    def clone_path
+      @clone_path ||= ::File.join(Gisture.configuration.tmpdir, owner, project)
+    end
+
+    def clone!(&block)
+      destroy_clone!
+      clone
+    end
+
+    def clone(&block)
+      return self if cloned?
+
+      Gisture.logger.info "[gisture] Cloning #{owner}/#{project} into #{clone_path}"
+
+      repo_url = "https://#{Gisture.configuration.github.auth_str}@github.com/#{owner}/#{project}.git"
+      Git.clone(repo_url, project, path: ::File.dirname(clone_path))
+
+      FileUtils.rm_rf("#{clone_path}/.git")
+      ::File.write("#{clone_path}/.gisture", Time.now.to_i.to_s)
+
+      if block_given?
+        instance_eval &block
+        destroy_clone!
+      end
+
+      self
+    end
+
+    def destroy_clone!
+      FileUtils.rm_rf(clone_path)
+    end
+
+    def cloned?
+      ::File.read("#{clone_path}/.gisture").strip
+    rescue
+      false
+    end
+
     protected
 
     def initialize(repo)
       @owner, @project = self.class.parse_repo_url(repo)
       raise OwnerBlacklisted.new(owner) unless Gisture.configuration.whitelisted?(owner)
     end
-
-    def github_config
-      github_config = Hash[Gisture::GITHUB_CONFIG_OPTS.map { |key| [key, Gisture.configuration.send(key)] }]
-    end
   end
 end

data/lib/gisture/repo_file.rb

@@ -0,0 +1,11 @@
+module Gisture
+  class RepoFile < File
+    protected
+
+    def initialize(file, basename: nil, strategy: nil)
+      file['filename'] = ::File.basename(file['path'])
+      file['content'] = Base64.decode64(file['content'])
+      super(file, basename: basename, strategy: strategy)
+    end
+  end
+end

data/lib/gisture/version.rb

@@ -1,3 +1,3 @@
 module Gisture
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

data/lib/gisture.rb

@@ -1,10 +1,13 @@
 require 'canfig'
+require 'git'
 require 'github_api'
 require 'gisture/github_api/client/gists'
 require 'gisture/version'
 require 'gisture/errors'
 require 'gisture/evaluator'
 require 'gisture/file'
+require 'gisture/cloned_file'
+require 'gisture/repo_file'
 require 'gisture/gist'
 require 'gisture/repo'
 require 'gisture/railtie' if defined?(Rails)
@@ -12,21 +15,26 @@ require 'gisture/railtie' if defined?(Rails)
 module Gisture
   include Canfig::Module
 
-  GITHUB_CONFIG_OPTS = [:basic_auth, :oauth_token, :client_id, :client_secret, :user, :org]
-
   configure do |config|
+    config.logger         = nil           # defaults to STDOUT but will use Rails.logger in a rails environment
+    config.strategy       = :eval         # default execution strategy
+    config.tmpdir         = Dir.tmpdir    # location to store gist tempfiles
+    config.owners         = nil           # only allow gists/repos/etc. from whitelisted owners (str/sym/arr)
+
     # config options for the github_api gem
-    config.basic_auth     = nil # user:password string
-    config.oauth_token    = nil # oauth authorization token
-    config.client_id      = nil # oauth client id
-    config.client_secret  = nil # oauth client secret
-    config.user           = nil # global user used in requets if none provided
-    config.org            = nil # global organization used in request if none provided
-
-    config.logger         = nil         # defaults to STDOUT but will use Rails.logger in a rails environment
-    config.strategy       = :eval       # default execution strategy
-    config.tmpdir         = Dir.tmpdir  # location to store gist tempfiles
-    config.owners         = nil         # only allow gists/repos/etc. from whitelisted owners (str/sym/arr)
+    config.github = Canfig::OpenConfig.new do |github_config|
+      github_config.basic_auth     = nil  # user:password string
+      github_config.oauth_token    = nil  # oauth authorization token
+      github_config.client_id      = nil  # oauth client id
+      github_config.client_secret  = nil  # oauth client secret
+      github_config.user           = nil  # global user used in requets if none provided
+      github_config.org            = nil  # global organization used in request if none provided
+
+      def auth_str
+        return "#{oauth_token}:x-oauth-basic" if oauth_token
+        return basic_auth if basic_auth
+      end
+    end
 
     def whitelisted?(owner)
       owners.nil? || owners.empty? || [owners].flatten.map(&:to_s).include?(owner)

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@ Coveralls.wear!
 Dir[File.join(File.dirname(__FILE__), '..', "spec/support/**/*.rb")].each { |f| require f }
 
 Gisture.configure do |config|
-  config.oauth_token = ENV['GITHUB_OAUTH_TOKEN']
+  config.github.oauth_token = ENV['GITHUB_OAUTH_TOKEN']
 end
 
 TEST_GIST_ID = "520b474ea0248d1a0a74"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gisture
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-03 00:00:00.000000000 Z
+date: 2015-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: canfig
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    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: github_api
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: kommand
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -69,11 +97,18 @@ dependencies:
 description: Execute one-off gists inline or in the background.
 email:
 - mark@markrebec.com
-executables: []
+executables:
+- gisture
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/gisture
 - lib/gisture.rb
+- lib/gisture/cli.rb
+- lib/gisture/cloned_file.rb
+- lib/gisture/commands.rb
+- lib/gisture/commands/gist/run.rb
+- lib/gisture/commands/repo/run.rb
 - lib/gisture/errors.rb
 - lib/gisture/evaluator.rb
 - lib/gisture/file.rb
@@ -81,6 +116,7 @@ files:
 - lib/gisture/github_api/client/gists.rb
 - lib/gisture/railtie.rb
 - lib/gisture/repo.rb
+- lib/gisture/repo_file.rb
 - lib/gisture/version.rb
 - lib/tasks/gisture.rake
 - spec/gists/called_class.rb