shard 0.1.1 → 0.2.0

data/bin/shard

@@ -2,7 +2,6 @@
 
 $:.unshift 'lib'
 
-require 'thor'
 require 'shard'
 require 'shard/cli'
 

data/lib/shard.rb

@@ -1,13 +1,25 @@
 class Shard
-  class << self
-    attr_accessor :current_loader
+  
+  def self.api
+    @api ||= Octokit::Client.new netrc: (Credentials.saved? && Credentials.valid?)
   end
+
+  def self.Ref(shard_line)
+    case shard_line
+    when String     then Shard::Ref.parse(shard_line)
+    when Shard::Ref then shard_line
+                    else raise ArgumentError
+    end
+  end
+
+  require 'shard/credentials'
+  require 'shard/shard_directory'
+  require 'shard/loader'
+  require 'shard/saver'
+  require 'shard/lister'
+  require 'shard/gist'
+  require 'shard/ref'
+  require 'shard/kernel'
+
 end
 
-require 'shard/shard_directory'
-require 'shard/loader'
-require 'shard/saver'
-require 'shard/lister'
-require 'shard/gist'
-require 'shard/shard_record'
-require 'shard/kernel'

data/lib/shard/cli.rb

@@ -1,72 +1,23 @@
-require 'thor'
-
-class Shard::CLI < Thor
-
-  ########
-  #      #
-  # List #
-  #      #
-  ########
-  
-  desc "list USERNAME", "List all shards for Github user USERNAME"
+module Shard::CLI
+
+  require 'shard/cli/commands'
+  require 'shard/cli/config'
+  require 'shard/cli/list'
+  require 'shard/cli/fork'
+
+  ##################
+  #                #
+  # Module Methods #
+  #                #
+  ##################
   
-  def list(username)
-    lister = Shard::Lister.new(username)
-
-    if lister.shards.any?
-      puts "Shards for Github user #{ username }:"
-      puts
-
-      lister.shard_names.each do |name|
-        shard = lister.shards[name]
-        puts "#{ name }:"
-        puts "  Description | #{ shard.description }"
-        puts "  URL         | #{ shard.url }"
-        puts
-      end
-    else
-      puts "Github user #{ username } does not have any shards."
-      puts "Shards are gists that have a file named shard.rb or <foo>.shard.rb"
+  def self.start(args)
+    if Shard::Ref.valid?(args[0])
+      args << "exec" if args.length == 1
+      args[0], args[1] = args[1], args[0]
     end
-  end
-
-  ########
-  #      #
-  # Exec #
-  #      #
-  ########
-  
-  desc "exec USERNAME/SHARD", "Runs the shard named SHARD for Github user USERNAME"
-
-  def exec(shard_line)
-    Shard::Loader.load shard_line
-  end
-
-  #########
-  #       #
-  # Fetch #
-  #       #
-  #########
-  
-  desc "fetch USERNAME/SHARD", "Downloads the shard named SHARD for Github user USERNAME"
-
-  def fetch(shard_line)
-    username, shard = shard_line.split '/'
-    shard = Shard::ShardRecord.new(username, shard, 'HEAD')
-
-    Shard::Saver.save(shard, verbose: true)
-  end
-
-  ########
-  #      #
-  # Test #
-  #      #
-  ########
-  
-  desc "test USERNAME/SHARD", "Runs the tests for shard named SHARD for Github user USERNAME"
 
-  def test(shard_line)
-    Shard::Loader.test shard_line
+    Commands.start(args)
   end
 
 end

data/lib/shard/cli/commands.rb

@@ -0,0 +1,102 @@
+require 'thor'
+
+module Shard::CLI
+
+  class Commands < Thor
+
+    ########
+    #      #
+    # List #
+    #      #
+    ########
+    
+    desc "list USERNAME", "List all shards for Github user USERNAME"
+    
+    def list(username)
+      Shard::CLI::List.run(username)
+    end
+
+    ########
+    #      #
+    # Exec #
+    #      #
+    ########
+    
+    desc "USERNAME/SHARD", "Runs the shard named SHARD for Github user USERNAME"
+
+    def exec(shard_line)
+      Shard::Loader.load shard_line
+    end
+
+    #########
+    #       #
+    # Fetch #
+    #       #
+    #########
+    
+    desc "USERNAME/SHARD fetch", "Downloads the shard named SHARD for Github user USERNAME"
+
+    def fetch(shard_line)
+      Shard::Saver.save shard_line, verbose: true
+    end
+
+    ########
+    #      #
+    # Test #
+    #      #
+    ########
+    
+    desc "USERNAME/SHARD test", "Runs the tests for shard named SHARD for Github user USERNAME"
+
+    def test(shard_line)
+      Shard::Loader.test shard_line
+    end
+
+    ##########
+    #        #
+    # Config #
+    #        #
+    ##########
+    
+    desc "config", "Set up Github credentials for use in shard"
+
+    def config
+      Shard::CLI::Config.run
+    end
+
+    ########
+    #      #
+    # View #
+    #      #
+    ########
+    
+    desc "USERNAME/SHARD view", "Opens the shard in a browser window"
+
+    def view(shard_line)
+      if line = Shard::Ref.parse(shard_line)
+        lister = Shard::Lister.new(line.user)
+        shard  = lister.shards[line.name]
+        url    = shard.url
+
+        `open #{ url }`
+      else
+        puts "'#{ shard_line }' is not a valid shard reference."
+      end
+    end
+
+    ########
+    #      #
+    # Fork #
+    #      #
+    ########
+    
+    desc "USERNAME/SHARD fork", "Forks a copy of the shard into your Github account (requires authentication)"
+
+    def fork(shard_line)
+        Shard::CLI::Fork.run shard_line
+    end
+
+
+  end
+
+end

data/lib/shard/cli/config.rb

@@ -0,0 +1,102 @@
+require 'io/console'
+
+module Shard::CLI
+
+  class Config
+
+    #################
+    #               #
+    # Class Methods #
+    #               #
+    #################
+    
+    def self.run
+      new.run
+    end
+
+    ####################
+    #                  #
+    # Instance Methods #
+    #                  #
+    ####################
+    
+    def run
+      if credentials_saved?
+        replace_credentials
+      else
+        add_credentials
+      end
+    end
+
+    private
+
+    def add_credentials
+      puts <<-EOF
+To use shard features that require a Github login,
+please enter your username and password below.
+
+Note, you can provide an Personal Access Token instead
+of a password (recommended).
+(See https://github.com/settings/tokens/new for more information)
+
+EOF
+
+      print "  Username | "
+      username = STDIN.gets.to_s.chomp
+      print "  Password | "
+      password = STDIN.noecho(&:gets).to_s.chomp
+
+      save_credentials(username, password)
+
+      if credentials_saved?
+        puts "\nCredentials saved to ~/.netrc"
+
+        validate_login
+      else
+        puts "\nCredentials have been cleared."
+      end
+    end
+
+    def credentials_saved?
+      Shard::Credentials.saved?
+    end
+
+    def replace_credentials
+      str = valid_login? ? "" : "invalid "
+      
+      puts "You currently have #{ str }Github credentials saved in ~/.netrc"
+      print "Do you wish to replace them? [yn] "
+
+      if yes?
+        add_credentials
+      end
+    end
+
+    def save_credentials(username, password)
+      Shard::Credentials.new(username, password).save
+    end
+
+    def validate_login
+      if valid_login?
+        puts "\nThe saved Github credentials are valid."
+      else
+        puts "\nThe saved Github credentials are invalid."
+        print "Do you wish to re-enter them? [yn] "
+
+        if yes?
+          add_credentials
+        end
+      end
+    end
+
+    def valid_login?
+      Shard::Credentials.valid?
+    end
+
+    def yes?
+      STDIN.gets.chomp.downcase == 'y'
+    end
+
+  end
+
+end

data/lib/shard/cli/fork.rb

@@ -0,0 +1,73 @@
+module Shard::CLI
+
+  class Fork
+
+    ################
+    #              #
+    # Declarations #
+    #              #
+    ################
+    
+    attr_reader :ref
+
+    ###############
+    #             #
+    # Constructor #
+    #             #
+    ###############
+    
+    def initialize(shard_line)
+      @ref = Shard::Ref(shard_line)
+    end
+
+    #################
+    #               #
+    # Class Methods #
+    #               #
+    #################
+    
+    def self.run(shard_line)
+      new(shard_line).run
+    end
+
+    ####################
+    #                  #
+    # Instance Methods #
+    #                  #
+    ####################
+    
+    def run
+      if ref.nil?
+        puts "That is not a valid shard reference."
+        return
+      end
+
+      if Shard::Credentials.saved? && Shard::Credentials.valid?
+        fork_shard
+      else
+        puts "You are not currently logged into Github."
+        Shard::CLI::Config.run
+
+        if Shard::Credentials.saved?
+          run
+        end
+      end
+    end
+
+    private
+
+    def fork_shard
+      lister = Shard::Lister.new(ref.user)
+      shard  = lister.shards[ref.name]
+
+      if shard
+        puts "Forking #{ ref.user }/#{ ref.name }..."
+        Shard.api.fork_gist(shard.id)
+      else
+        puts "That is not a valid shard reference."
+      end
+    end
+
+  end
+
+end

data/lib/shard/cli/list.rb

@@ -0,0 +1,46 @@
+module Shard::CLI
+
+  class List
+
+    #################
+    #               #
+    # Class Methods #
+    #               #
+    #################
+    
+    def self.run(username)
+      new.run(username)
+    end
+
+    ####################
+    #                  #
+    # Instance Methods #
+    #                  #
+    ####################
+    
+    def run(username)
+      lister = Shard::Lister.new(username)
+
+      if lister.shards.any?
+        puts "Shards for Github user #{ username }:"
+        puts
+
+        lister.shard_names.each do |name|
+          shard = lister.shards[name]
+          puts "#{ name }:"
+          puts "  Description | #{ shard.description }"
+          puts "  URL         | #{ shard.url }"
+          puts
+        end
+      else
+        puts "Github user #{ username } does not have any shards."
+        puts "Shards are gists that have a file named shard.rb or <foo>.shard.rb"
+      end
+    end
+
+    private
+
+  end
+
+end
+

data/lib/shard/credentials.rb

@@ -0,0 +1,61 @@
+require 'octokit'
+require 'netrc'
+
+class Shard
+
+  class Credentials < Struct.new(:username, :password)
+
+    ################
+    #              #
+    # Declarations #
+    #              #
+    ################
+    
+    GITHUB_API_ENTRY = "api.github.com"
+
+    #################
+    #               #
+    # Class Methods #
+    #               #
+    #################
+    
+    def self.current
+      username, password = Netrc.read[GITHUB_API_ENTRY]
+      new(username, password)
+    end
+
+    def self.saved?
+      current.present?
+    end
+
+    def self.valid?
+      Octokit.validate_credentials netrc: true
+    end
+
+    ####################
+    #                  #
+    # Instance Methods #
+    #                  #
+    ####################
+    
+    def save
+      if present?
+        netrc_file[GITHUB_API_ENTRY] = username, password
+      else
+        netrc_file.delete GITHUB_API_ENTRY
+      end
+
+      netrc_file.save
+    end
+
+    def netrc_file
+      @netrc_file ||= Netrc.read
+    end
+
+    def present?
+      !(username.to_s == '' || password.to_s == '')
+    end
+
+  end
+
+end

data/lib/shard/lister.rb

@@ -1,5 +1,3 @@
-require 'octokit'
-
 class Shard
 
   class Lister
@@ -48,7 +46,7 @@ class Shard
     private
 
     def fetch_gists
-      Octokit.gists username
+      Shard.api.gists username
     end
 
     def gist_by_id(id)

data/lib/shard/loader.rb

@@ -10,9 +10,10 @@ class Shard
     
     include ShardDirectory
 
-    attr_reader :shard
+    SHARD_FILE_PATTERN = %q(*shard.rb)
+    TEST_FILE_PATTERNS = %w( *_spec.rb *_test.rb )
 
-    SHARD_LINE_REGEX = %r{([a-zA-Z0-9_-]+)/(\w+)(?::(\w+))?}
+    attr_reader :ref
 
     ###############
     #             #
@@ -21,7 +22,7 @@ class Shard
     ###############
     
     def initialize(shard_line)
-      parse_shard_line(shard_line)
+      @ref = Shard::Ref(shard_line)
     end
 
     #################
@@ -45,69 +46,25 @@ class Shard
     ####################
     
     def load
-      ensure_shard_saved
-
-      Shard.current_loader, previous_loader = self, Shard.current_loader
-      require shard_file_path
-      Shard.current_loader = previous_loader
+      load_file(SHARD_FILE_PATTERN)
     end
 
     def load_file(filename)
-      path = filename ? ruby_file_path(filename) : shard_file_path
-      require path
+      ensure_shard_saved
+
+      require find_file_path(ref, filename)
     end
 
     def test
       ensure_shard_saved
 
-      Shard.current_loader, previous_loader = self, Shard.current_loader
-      require *shard_test_paths
-      Shard.current_loader = previous_loader
+      require *find_file_paths(ref, *TEST_FILE_PATTERNS)
     end
 
     private
 
-    def already_loaded?
-      shard_dir_exists?(shard.username, shard.name, shard.version)
-    end
-
     def ensure_shard_saved
-      unless already_loaded?
-        Shard::Saver.save shard
-      end
-    end
-
-    def parse_shard_line(shard_line)
-      if match = shard_line.match(SHARD_LINE_REGEX)
-        username = match[1]
-        name     = match[2]
-        version  = parse_version match[3]
-
-        @shard = Shard::ShardRecord.new(username, name, version)
-      end
-    end
-
-    def parse_version(raw_version)
-      raw_version || 'HEAD'
-    end
-
-    def ruby_file_path(filename)
-      file_path(shard.username, shard.name, shard.version, filename)
-    end
-
-    def shard_file_path
-      path = file_path(shard.username, shard.name, shard.version, '*shard.rb')
-      Dir[ path ].first
-    end
-
-    def shard_test_paths
-      test_path  = file_path(shard.username, shard.name, shard.version, '*_test.rb')
-      test_files = Dir[ test_path ]
-
-      spec_path  = file_path(shard.username, shard.name, shard.version, '*_spec.rb')
-      spec_files = Dir[ spec_path ]
-
-      test_files + spec_files
+      Shard::Saver.save ref, lazy: true
     end
 
   end

data/lib/shard/ref.rb

@@ -0,0 +1,38 @@
+class Shard
+
+  class Ref < Struct.new(:user, :name, :file, :version)
+
+    ################
+    #              #
+    # Declarations #
+    #              #
+    ################
+    
+    PATTERN = %r{([a-zA-Z0-9_-]+)/(\w+)} # (?::(\w+))?
+
+    #################
+    #               #
+    # Class Methods #
+    #               #
+    #################
+    
+    def self.parse(shard_line)
+      if matcher = shard_line.match(PATTERN)
+        user    = matcher[1]
+        name    = matcher[2]
+        file    = nil
+        version = 'HEAD'
+
+        new(user, name, file, version)
+      else
+        nil
+      end
+    end
+
+    def self.valid?(shard_line)
+      shard_line =~ PATTERN
+    end
+
+  end
+
+end

data/lib/shard/saver.rb

@@ -10,7 +10,9 @@ class Shard
     
     include ShardDirectory
 
-    attr_reader :shard, :gist, :full_gist, :options
+    attr_reader :ref, :gist, :full_gist, :options
+
+    SHA_LENGTH = 8
 
     ###############
     #             #
@@ -18,8 +20,8 @@ class Shard
     #             #
     ###############
     
-    def initialize(shard, options = {})
-      @shard   = shard
+    def initialize(shard_line_or_ref, options = {})
+      @ref     = Shard::Ref(shard_line_or_ref)
       @options = options
     end
 
@@ -29,8 +31,8 @@ class Shard
     #               #
     #################
     
-    def self.save(shard, options = {})
-      new(shard, options).save!
+    def self.save(shard_line, options = {})
+      new(shard_line, options).save!
     end
 
     ####################
@@ -40,7 +42,9 @@ class Shard
     ####################
     
     def save!
-      create_shard_dir(shard.username, shard.name, shard.version)
+      return if shard_dir_exists?(ref) && options[:lazy]
+      
+      create_shard_dir(ref)
       fetch_shard_contents
 
       gist.all_files.each do |file|
@@ -48,16 +52,16 @@ class Shard
       end
 
       if options[:verbose]
-        puts "VERSION #{ version(8) }..."
+        puts "VERSION #{ version }..."
       end
     end
 
     private
 
     def fetch_shard_contents
-      lister     = Shard::Lister.new(shard.username)
-      @gist      = lister.shards[shard.name]
-      @full_gist = Octokit.gist gist.id
+      lister     = Shard::Lister.new(ref.user)
+      @gist      = lister.shards[ref.name]
+      @full_gist = Shard.api.gist gist.id
     end
 
     def file_contents(filename)
@@ -65,7 +69,7 @@ class Shard
     end
 
     def write_file(file)
-      path     = file_path(shard.username, shard.name, shard.version, file.filename)
+      path     = file_path(ref, file.filename)
       contents = file_contents(file.filename)
 
       if options[:verbose]
@@ -75,7 +79,7 @@ class Shard
       File.write path, contents
     end
     
-    def version(length)
+    def version(length = SHA_LENGTH)
       full_version = full_gist.history.first.version
       full_version[0...length]
     end

data/lib/shard/shard_directory.rb

@@ -8,36 +8,40 @@ class Shard
     #                #
     ##################
     
-    def create_root
-      unless Dir.exists?(path)
-        Dir.mkdir(path)
-      end
-    end
-
-    def create_shard_dir(username, shard, version)
-      dir = directory(username, shard, version)
+    def create_shard_dir(ref)
+      dir = directory(ref)
 
-      unless shard_dir_exists?(username, shard, version)
+      unless shard_dir_exists?(ref)
         FileUtils.mkpath(dir)
       end
     end
 
-    def shard_dir_exists?(username, shard, version)
-      dir = directory(username, shard, version)
-
-      Dir.exists?(dir)
+    def shard_dir_exists?(ref)
+      Dir.exists? directory(ref)
     end
 
-    def directory(username, shard, version)
-      File.join(path, username, shard, version)
+    def directory(ref)
+      File.join(root_path, ref.user, ref.name, ref.version)
     end
 
-    def path
+    def root_path
       File.join(Dir.home, '.shard')
     end
 
-    def file_path(username, shard, version, filename)
-      File.join( directory(username, shard, version), filename )
+    def file_path(ref, filename, options = {})
+      File.join( directory(ref), filename )
+    end
+
+    def find_file_path(ref, filename, options = {})
+      find_file_paths(ref, filename).first
+    end
+
+    def find_file_paths(ref, *filenames)
+      full_names = filenames.map do |filename|
+        File.join( directory(ref), filename)
+      end
+
+      Dir[ *full_names ]
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shard
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,27 +12,60 @@ cert_chain: []
 date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: &70160527980780 !ruby/object:Gem::Requirement
+  name: octokit
+  requirement: &70161726787500 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - =
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.25.0
   type: :runtime
   prerelease: false
-  version_requirements: *70160527980780
+  version_requirements: *70161726787500
 - !ruby/object:Gem::Dependency
-  name: octokit
-  requirement: &70160527979280 !ruby/object:Gem::Requirement
+  name: netrc
+  requirement: &70161726786820 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.25.0
+        version: 0.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *70161726786820
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70161726786340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.18.1
   type: :runtime
   prerelease: false
-  version_requirements: *70160527979280
+  version_requirements: *70161726786340
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70161726785960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70161726785960
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70161726785480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70161726785480
 description: ! 'Shard is a light-weight code loading-and-running-and-sharing tool,
   built on top of http://gist.github.com.
 
@@ -48,14 +81,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/shard.rb
+- lib/shard/cli/commands.rb
+- lib/shard/cli/config.rb
+- lib/shard/cli/fork.rb
+- lib/shard/cli/list.rb
 - lib/shard/cli.rb
+- lib/shard/credentials.rb
 - lib/shard/gist.rb
 - lib/shard/kernel.rb
 - lib/shard/lister.rb
 - lib/shard/loader.rb
+- lib/shard/ref.rb
 - lib/shard/saver.rb
 - lib/shard/shard_directory.rb
-- lib/shard/shard_record.rb
 - bin/shard
 homepage: https://github.com/mark/shard
 licenses:

data/lib/shard/shard_record.rb

@@ -1,29 +0,0 @@
-class Shard::ShardRecord
-
-  ################
-  #              #
-  # Declarations #
-  #              #
-  ################
-  
-  attr_reader :username, :name, :version
-
-  ###############
-  #             #
-  # Constructor #
-  #             #
-  ###############
-  
-  def initialize(username, name, version = "HEAD")
-    @username = username
-    @name     = name
-    @version  = version
-  end
-
-  ####################
-  #                  #
-  # Instance Methods #
-  #                  #
-  ####################
-
-end