gisture 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd3a20fe2d04688228edbaa5cf0b7ea1fdc9ad66
-  data.tar.gz: 79062e1a7cfeb4c58a1add028f90195d987fb953
+  metadata.gz: 204135cbcc13305754d2b3a0558222ec220eae6b
+  data.tar.gz: 068ea799d72c1678747b1cef3a7c93a48a2ebd5d
 SHA512:
-  metadata.gz: 1a9ed38b608e1f52182cf2a23ab18f301eb80d70de804f9b8de1716bb4c057f3a8b884c8ce4704da69aa5e836704f38091f69af728c399d269a38616aaca96dc
-  data.tar.gz: bfcaf28ea0329a488fc232785980c3cf14eb90fa1999b5722bc6bc6adbfa17f31024dade585a453addde02f4c7e12398fa0f49003560fa4c1eaf91ee4dcfc78b
+  metadata.gz: b53b53175b706be880fae8e9e32609edae8909bcc6dc3d3076a698c1f6e05b3463402ce7958fcc578f5bd48e9830a386d666546f60643f8424a52788c83263b0
+  data.tar.gz: 2e8a7e5565c63d09cb28ec6df0e229c399f0836b33a5a7c14f2286509e57adde000845d35947ed6183fec3e80b6476d07147ccf99f5ea51e5d9609d3b2eed435

data/lib/gisture/evaluator.rb

@@ -1,12 +1,16 @@
 module Gisture
   class Evaluator
-    attr_reader :raw
+    attr_reader :raw, :result
+
+    def evaluate
+      instance_eval { @result = eval raw }
+    end
 
     protected
     
     def initialize(raw)
-      @raw = raw
-      instance_eval { eval raw }
+      @raw = raw.to_s
+      evaluate
     end
   end
 end

data/lib/gisture/gist.rb

@@ -2,12 +2,14 @@ require 'tempfile'
 
 module Gisture
   class Gist
-    attr_reader :filename, :gist_id, :strategy
+    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/
 
-    def self.run!(gist_id: nil, strategy: nil, filename: nil, version: nil, &block)
-      new(gist_id: gist_id, strategy: strategy, filename: filename, version: version).run!(&block)
+    def self.run!(gist, strategy: nil, filename: nil, version: nil, &block)
+      new(gist, strategy: strategy, filename: filename, version: version).run!(&block)
     end
 
     def run!(&block)
@@ -34,7 +36,7 @@ module Gisture
 
     def github
       @github ||= begin
-        github_config = Gisture::GITHUB_CONFIG_OPTS.map { |key| [key, Gisture.configuration.send(key)] }.to_h
+        github_config = Hash[Gisture::GITHUB_CONFIG_OPTS.map { |key| [key, Gisture.configuration.send(key)] }]
         Github.new(github_config)
       end
     end
@@ -85,23 +87,42 @@ module Gisture
 
     def to_h
       { gist_id: gist_id,
+        version: version,
         strategy: strategy,
         filename: filename }
     end
 
     protected
 
-    def initialize(gist_id: nil, strategy: nil, filename: nil, version: nil)
-      raise ArgumentError, "Invalid gist_id" if gist_id.nil?
-      @gist_id = gist_id
-      @filename = filename
-      @version = version
+    def initialize(gist, strategy: nil, filename: nil, version: nil)
       self.strategy = strategy || :eval
+      @filename = filename
+
+      if gist.match(/[^a-f0-9]+/i) # non-hex chars, probably a URL
+        @gist_id, @version = parse_gist_url(gist)
+        @version = version unless version.nil?
+      else
+        @gist_id = gist
+        @version = version
+      end
+
     end
 
     def unlink_tempfile
       tempfile.unlink
       @tempfile = nil
     end
+
+    def parse_gist_url(gist_url)
+      case gist_url.to_s
+      when GIST_URL_WITH_VERSION_REGEX
+        matches = gist_url.match(GIST_URL_WITH_VERSION_REGEX)
+        return [matches[1], matches[2]]
+      when GIST_URL_REGEX
+        return [gist_url.match(GIST_URL_REGEX)[1], nil]
+      else
+        raise ArgumentError, "Invalid argument: #{gist_url} is not a valid gist URL."
+      end
+    end
   end
 end

data/lib/gisture/version.rb

@@ -1,3 +1,3 @@
 module Gisture
-  VERSION = '0.0.3'
+  VERSION = '0.0.5'
 end

data/lib/gisture.rb

@@ -1,5 +1,6 @@
 require 'canfig'
 require 'github_api'
+require 'gisture/github_api/client/gists'
 require 'gisture/version'
 require 'gisture/evaluator'
 require 'gisture/gist'
@@ -22,11 +23,11 @@ module Gisture
     config.tmpdir         = Dir.tmpdir  # location to store gist tempfiles
   end
 
-  def self.new(gist_id, strategy=nil, filename=nil, version=nil)
-    Gisture::Gist.new(gist_id: gist_id, strategy: strategy, filename: filename, version: version)
+  def self.new(gist, strategy: nil, filename: nil, version: nil)
+    Gisture::Gist.new(gist, strategy: strategy, filename: filename, version: version)
   end
 
-  def self.run(gist_id, strategy=nil, filename=nil, version=nil, &block)
-    new(gist_id, strategy, filename, version).run!(&block)
+  def self.run(gist, strategy: nil, filename: nil, version: nil, &block)
+    new(gist, strategy, filename, version).run!(&block)
   end
 end

data/lib/tasks/gisture.rake

@@ -2,8 +2,8 @@ require 'gisture'
 
 namespace 'gisture' do
   desc 'Run a github gist in a rake task'
-  task :run, [:gist_id, :strategy, :filename, :runner] => :environment do |t,args|
+  task :run, [:gist_id, :strategy, :filename, :version, :runner] => :environment do |t,args|
     runner = Proc.new { eval(args.runner.to_s) }
-    Gisture.run(args.gist_id, args.strategy, args.filename, &runner)
+    Gisture.run(args.gist_id, strategy: args.strategy, filename: args.filename, version: args.version, &runner)
   end
 end

data/spec/gisture/evaluator_spec.rb

@@ -1,4 +1,27 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe Gisture::Evaluator do
+  it "requires a string to be eval'd" do
+    expect { Gisture::Evaluator.new }.to raise_exception(ArgumentError)
+  end
+
+  it "converts raw input to a string" do
+    expect { Gisture::Evaluator.new(nil) }.to_not raise_exception
+  end
+
+  describe "#raw" do
+    subject { Gisture::Evaluator.new("1+1") }
+
+    it "stores the raw string passed on init" do
+      expect(subject.raw).to eql("1+1")
+    end
+  end
+
+  describe "#result" do
+    subject { Gisture::Evaluator.new("1+1") }
+
+    it "stores the result returned by evaluating the block" do
+      expect(subject.result).to eql(2)
+    end
+  end
 end

data/spec/gisture/gist_spec.rb

@@ -1,4 +1,194 @@
-require 'spec_helper'
+require "spec_helper"
+
+TEST_GIST_ID = "520b474ea0248d1a0a74"
+TEST_GIST_URL = "https://gist.github.com/markrebec/520b474ea0248d1a0a74"
+TEST_GIST_VERSION = "49a9d887eeb8c723ab23deddfbbb75d4b70e8014"
+TEST_GIST_VERSION_URL = "https://gist.github.com/markrebec/520b474ea0248d1a0a74/49a9d887eeb8c723ab23deddfbbb75d4b70e8014"
+TEST_GIST_FILENAME = "test.rb"
+MULTI_FILE_TEST_GIST_ID = "0417bf78a7c2b825b4ef"
+MULTI_FILE_TEST_GIST_FILENAMES = ['file_one.rb', 'file_two.rb']
 
 RSpec.describe Gisture::Gist do
+  context "when passing a gist ID" do
+    it "sets the gist ID as the gist_id" do
+      expect(Gisture::Gist.new(TEST_GIST_ID).gist_id).to eql(TEST_GIST_ID)
+    end
+
+    context "when passing a version" do
+      it "sets the version" do
+        expect(Gisture::Gist.new(TEST_GIST_ID, version: TEST_GIST_VERSION).version).to eql(TEST_GIST_VERSION)
+      end
+    end
+  end
+
+  context "when passing a gist URL" do
+    context "without a version" do
+      it "extracts and sets the gist ID as the gist_id" do
+        expect(Gisture::Gist.new(TEST_GIST_URL).gist_id).to eql(TEST_GIST_ID)
+      end
+
+      context "when passing a version separately" do
+        it "sets the version" do
+          expect(Gisture::Gist.new(TEST_GIST_URL, version: TEST_GIST_VERSION).version).to eql(TEST_GIST_VERSION)
+        end
+      end
+    end
+
+    context "with a version" do
+      it "extracts and sets the gist ID as the gist_id" do
+        expect(Gisture::Gist.new(TEST_GIST_VERSION_URL).gist_id).to eql(TEST_GIST_ID)
+      end
+
+      it "extracts and sets the gist version as the version" do
+        expect(Gisture::Gist.new(TEST_GIST_VERSION_URL).version).to eql(TEST_GIST_VERSION)
+      end
+
+      context "when passing a version separately" do
+        it "overrides the version with the one explicitly provided" do
+          expect(Gisture::Gist.new(TEST_GIST_VERSION_URL, version: "abc123").version).to eql("abc123")
+        end
+      end
+    end
+  end
+
+  context "when passing a filename" do
+    it "sets the filename" do
+      expect(Gisture::Gist.new(TEST_GIST_ID, filename: TEST_GIST_FILENAME).filename).to eql(TEST_GIST_FILENAME)
+    end
+  end
+
+  context "when passing a strategy" do
+    context "which is a valid strategy" do
+      it "sets the requested strategy" do
+        expect(Gisture::Gist.new(TEST_GIST_ID, strategy: :load).strategy).to eql(:load)
+      end
+    end
+
+    context "which is not a valid strategy" do
+      it "raises an ArgumentError" do
+        expect { Gisture::Gist.new(TEST_GIST_ID, strategy: :foo) }.to raise_exception(ArgumentError)
+      end
+    end
+  end
+
+  describe "#github" do
+    subject { Gisture::Gist.new(TEST_GIST_ID) }
+
+    it "is a github_api client object" do
+      expect(subject.github).to be_a(Github::Client)
+    end
+  end
+
+  describe "#gist" do
+    subject { Gisture::Gist.new(TEST_GIST_ID) }
+
+    it "is the gist that was requested" do
+      expect(subject.gist.id).to eql(TEST_GIST_ID)
+    end
+  end
+
+  describe "#gist_file" do
+    it "returns an array" do
+      expect(Gisture::Gist.new(TEST_GIST_ID).gist_file).to be_a(Array)
+    end
+
+    it "contains the filename and file object" do
+      gist = Gisture::Gist.new(TEST_GIST_ID)
+      expect(gist.gist_file[0]).to eql(TEST_GIST_FILENAME)
+      expect(gist.gist_file[1]).to be_a(Hashie::Mash)
+    end
+
+    context "when a gist contains a single file" do
+      it "returns the file" do
+        expect(Gisture::Gist.new(TEST_GIST_ID).gist_file[0]).to eql(TEST_GIST_FILENAME)
+      end
+    end
+
+    context "when a gist contains more than one file" do
+      context "and a filename is present" do
+        subject { Gisture::Gist.new(MULTI_FILE_TEST_GIST_ID, filename: MULTI_FILE_TEST_GIST_FILENAMES.sample) }
+
+        it "returns the specified file" do
+          expect(subject.gist_file[0]).to eql(subject.filename)
+        end
+      end
+
+      context "and no filename is present" do
+        subject { Gisture::Gist.new(MULTI_FILE_TEST_GIST_ID) }
+
+        it "raises an ArgumentError" do
+          expect { subject.gist_file }.to raise_exception(ArgumentError)
+        end
+      end
+    end
+  end
+
+  describe "#raw" do
+    subject { Gisture::Gist.new(TEST_GIST_ID) }
+
+    it "returns the raw gist content" do
+      expect(subject.raw).to eql(subject.gist_file[1].content)
+    end
+  end
+
+  describe "#strategy=" do
+    subject { Gisture::Gist.new(TEST_GIST_ID) }
+
+    context "when passed a valid strategy" do
+      it "sets the strategy" do
+        subject.strategy = :load
+        expect(subject.strategy).to eql(:load)
+      end
+    end
+
+    context "when passed an invalid strategy" do
+      it "raises an ArgumentError" do
+        expect { subject.strategy = :foo }.to raise_exception(ArgumentError)
+      end
+    end
+  end
+
+  describe "#tempfile" do
+    subject { Gisture::Gist.new(TEST_GIST_ID) }
+
+    it "creates and returns a tempfile" do
+      expect(subject.tempfile).to be_a(Tempfile)
+    end
+
+    it "uses the gist_id as the base of the filename" do
+      matched = File.basename(subject.tempfile.path).match(/#{TEST_GIST_ID}/)
+      expect(matched).to_not be_nil
+    end
+
+    it "uses the same extension as the gist's filename" do
+      expect(File.extname(subject.tempfile.path)).to eql(File.extname(subject.gist_file[0]))
+    end
+
+    it "creates the file in the configured tempdir" do
+      tmp_path = File.join(File.dirname(__FILE__), '../', 'tmp')
+      begin
+        FileUtils.mkdir_p tmp_path
+        Gisture.configure do |config|
+          config.tmpdir = tmp_path
+        end
+
+        expect(File.dirname(subject.tempfile.path)).to eql(tmp_path)
+      rescue => e
+        raise e
+      ensure
+        Gisture.configure do |config|
+          config.tmpdir = Dir.tmpdir
+        end
+        FileUtils.rm_rf tmp_path
+      end
+    end
+  end
+
+  describe "#to_h" do
+    subject { Gisture::Gist.new(TEST_GIST_ID, filename: "test.rb") }
+
+    it "returns a hash of the gist attributes" do
+      expect(subject.to_h).to eql({gist_id: TEST_GIST_ID, strategy: :eval, filename: "test.rb", version: nil})
+    end
+  end
 end

data/spec/gisture_spec.rb

@@ -1,4 +1,8 @@
-require 'spec_helper'
+require "spec_helper"
 
 RSpec.describe Gisture do
+  SAMPLE_GIST_ID = "c3b478ef0592eacad361".freeze
+  SAMPLE_GIST_VERSION = "7714df11a3babaa78f27027844ac2f0c1a8348c1".freeze
+  SAMPLE_GIST_URL = "https://gist.github.com/markrebec/#{SAMPLE_GIST_ID}".freeze
+  SAMPLE_GIST_URL_WITH_VERSION = "https://gist.github.com/markrebec/#{SAMPLE_GIST_ID}/#{SAMPLE_GIST_VERSION}".freeze
 end

data/spec/spec_helper.rb

@@ -3,7 +3,11 @@ require 'rspec'
 require 'coveralls'
 Coveralls.wear!
 
-#Dir[File.join(File.dirname(__FILE__), '..', "spec/support/**/*.rb")].each { |f| require f }
+Dir[File.join(File.dirname(__FILE__), '..', "spec/support/**/*.rb")].each { |f| require f }
+
+Gisture.configure do |config|
+  config.oauth_token = ENV['GITHUB_OAUTH_TOKEN']
+end
 
 RSpec.configure do |config|
   #config.before(:suite) do

data/spec/support/gists.rb

@@ -0,0 +1,5 @@
+TEST_GISTS = {
+  "520b474ea0248d1a0a74" => Hashie::Mash.new({"url"=>"https://api.github.com/gists/520b474ea0248d1a0a74", "forks_url"=>"https://api.github.com/gists/520b474ea0248d1a0a74/forks", "commits_url"=>"https://api.github.com/gists/520b474ea0248d1a0a74/commits", "id"=>"520b474ea0248d1a0a74", "git_pull_url"=>"https://gist.github.com/520b474ea0248d1a0a74.git", "git_push_url"=>"https://gist.github.com/520b474ea0248d1a0a74.git", "html_url"=>"https://gist.github.com/520b474ea0248d1a0a74", "files"=>Hashie::Mash.new({"test.rb" => Hashie::Mash.new({"filename"=>"test.rb", "type"=>"application/x-ruby", "language"=>"Ruby", "raw_url"=>"https://gist.githubusercontent.com/markrebec/520b474ea0248d1a0a74/raw/dc57de4d96283efb9b40215c3882bf4658a504ea/test.rb", "size"=>26, "truncated"=>false, "content"=>"puts \"1+1 = \#{(1+1).to_s}\""})}), "owner"=>{"login"=>"markrebec", "id"=>231971, "avatar_url"=>"https://avatars.githubusercontent.com/u/231971?v=3", "gravatar_id"=>"", "url"=>"https://api.github.com/users/markrebec", "html_url"=>"https://github.com/markrebec", "followers_url"=>"https://api.github.com/users/markrebec/followers", "following_url"=>"https://api.github.com/users/markrebec/following{/other_user}", "gists_url"=>"https://api.github.com/users/markrebec/gists{/gist_id}", "starred_url"=>"https://api.github.com/users/markrebec/starred{/owner}{/repo}", "subscriptions_url"=>"https://api.github.com/users/markrebec/subscriptions", "organizations_url"=>"https://api.github.com/users/markrebec/orgs", "repos_url"=>"https://api.github.com/users/markrebec/repos", "events_url"=>"https://api.github.com/users/markrebec/events{/privacy}", "received_events_url"=>"https://api.github.com/users/markrebec/received_events", "type"=>"User", "site_admin"=>false}}),
+
+  "0417bf78a7c2b825b4ef" => Hashie::Mash.new({"url"=>"https://api.github.com/gists/0417bf78a7c2b825b4ef", "forks_url"=>"https://api.github.com/gists/0417bf78a7c2b825b4ef/forks", "commits_url"=>"https://api.github.com/gists/0417bf78a7c2b825b4ef/commits", "id"=>"0417bf78a7c2b825b4ef", "git_pull_url"=>"https://gist.github.com/0417bf78a7c2b825b4ef.git", "git_push_url"=>"https://gist.github.com/0417bf78a7c2b825b4ef.git", "html_url"=>"https://gist.github.com/0417bf78a7c2b825b4ef", "files"=>Hashie::Mash.new({"file_one.rb" => Hashie::Mash.new({"filename"=>"file_one.rb", "type"=>"application/x-ruby", "language"=>"Ruby", "raw_url"=>"https://gist.githubusercontent.com/markrebec/0417bf78a7c2b825b4ef/raw/6074958bbcc281096357a7d014983638bb09ed1f/file_one.rb", "size"=>27, "truncated"=>false, "content"=>"5.times { puts \"File One\" }"}), "file_two.rb" => Hashie::Mash.new({"filename"=>"file_two.rb", "type"=>"application/x-ruby", "language"=>"Ruby", "raw_url"=>"https://gist.githubusercontent.com/markrebec/0417bf78a7c2b825b4ef/raw/9e1aafc8007f427d386813896387c01848b6bb33/file_two.rb", "size"=>27, "truncated"=>false, "content"=>"5.times { puts \"File Two\" }"})}), "owner"=>{"login"=>"markrebec", "id"=>231971, "avatar_url"=>"https://avatars.githubusercontent.com/u/231971?v=3", "gravatar_id"=>"", "url"=>"https://api.github.com/users/markrebec", "html_url"=>"https://github.com/markrebec", "followers_url"=>"https://api.github.com/users/markrebec/followers", "following_url"=>"https://api.github.com/users/markrebec/following{/other_user}", "gists_url"=>"https://api.github.com/users/markrebec/gists{/gist_id}", "starred_url"=>"https://api.github.com/users/markrebec/starred{/owner}{/repo}", "subscriptions_url"=>"https://api.github.com/users/markrebec/subscriptions", "organizations_url"=>"https://api.github.com/users/markrebec/orgs", "repos_url"=>"https://api.github.com/users/markrebec/repos", "events_url"=>"https://api.github.com/users/markrebec/events{/privacy}", "received_events_url"=>"https://api.github.com/users/markrebec/received_events", "type"=>"User", "site_admin"=>false}})
+}

data/spec/support/github_api.rb

@@ -0,0 +1,16 @@
+module Github
+  class Client::Gists < API
+    def get(*args)
+      arguments(args, required: [:id])
+
+      TEST_GISTS.to_a.find { |g| g.first == arguments.id }.last
+    end
+
+    def version(*args)
+      arguments(args, required: [:id, :version])
+
+      # TODO implement this
+      nil
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gisture
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Mark Rebec
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: canfig
@@ -76,9 +76,9 @@ files:
 - lib/gisture.rb
 - lib/gisture/evaluator.rb
 - lib/gisture/gist.rb
+- lib/gisture/github_api/client/gists.rb
 - lib/gisture/railtie.rb
 - lib/gisture/version.rb
-- lib/github_api/client/gists.rb
 - lib/tasks/gisture.rake
 - spec/gists/called_class.rb
 - spec/gists/called_method.rb
@@ -89,6 +89,8 @@ files:
 - spec/gisture/gist_spec.rb
 - spec/gisture_spec.rb
 - spec/spec_helper.rb
+- spec/support/gists.rb
+- spec/support/github_api.rb
 homepage: http://github.com/markrebec/gisture
 licenses: []
 metadata: {}
@@ -122,3 +124,5 @@ test_files:
 - spec/gisture/gist_spec.rb
 - spec/gisture_spec.rb
 - spec/spec_helper.rb
+- spec/support/gists.rb
+- spec/support/github_api.rb