ext 1.1.2 → 2.0.0

data/lib/externals/extensions/file_utils.rb

@@ -2,34 +2,34 @@ require 'fileutils'
 
 FileUtils.class_eval do
   # simulates cp -a
-  def cp_a source, dest, options = {}
-    cp_r source, dest, options.merge(:preserve => true)
+  def cp_a source, dest, **options
+    cp_r source, dest, **options, :preserve => true
   end
 
   # calls rm_rf if the file exists
-  def rm_rf_ie file, options = {}
-    rm_rf file, options if File.exists? file
+  def rm_rf_ie file, **options
+    rm_rf(file, **options) if File.exist?(file)
   end
 
   # calls rmdir if the file exists and is empty
   def rmdir_if_empty_ie path
-    rmdir path if File.exists?(path) && dir_empty?(path)
+    rmdir path if File.exist?(path) && dir_empty?(path)
   end
 
   # calls rmdir if the file exists
   def rmdir_ie path
-    rmdir path if File.exists?(path)
+    rmdir path if File.exist?(path)
   end
 
-  alias rm_rf_old rm_rf
+  alias_method :rm_rf_old, :rm_rf
   #going to try to give a delay after calling rm if necessary...
-  def rm_rf *args
+  def rm_rf(filename, *args, **opts)
     tries = 0
 
     rm = proc do
-      rm_rf_old *args
+      rm_rf_old(filename, *args, **opts)
 
-      while File.exists?(args[0]) && tries < 10
+      while File.exist?(filename) && tries < 10
         # :nocov:
         sleep 1
         tries += 1
@@ -40,12 +40,12 @@ FileUtils.class_eval do
     rm.call
     if tries >= 10
       # :nocov:
-      puts "WARNING: deleted #{args[0]} didn't work, trying again"
+      puts "WARNING: deleted #{filename} didn't work, trying again"
       tries = 0
       rm.call
 
       if tries >= 10
-        raise "Could not delete #{args[0]}"
+        raise "Could not delete #{filename}"
       end
       # :nocov:
     end
@@ -53,7 +53,7 @@ FileUtils.class_eval do
 
   def dir_empty? path
     File.directory?(path) &&
-      File.exists?(path) &&
-      !Dir.entries(path).detect{|entry| !["..","."].include?(entry)}
+      File.exist?(path) &&
+      !Dir.entries(path).detect{|entry| !["..", "."].include?(entry)}
   end
-end
+end

data/lib/externals/extensions/string.rb

@@ -1,6 +1,6 @@
 String.class_eval do
   def cap_first
-    "#{self[0].chr.upcase}#{self[1..(self.length - 1)]}"
+    "#{self[0].chr.upcase}#{self[1..]}"
   end
 
   def classify
@@ -8,24 +8,22 @@ String.class_eval do
   end
 
   #avoid collision
-  raise if instance_methods.include?("lines_by_width")
+  raise if method_defined?("lines_by_width")
+
   def lines_by_width(width = 32)
     width ||= 32
     lines = []
     string = gsub(/\s+/, ' ')
-    while string.size > 0
+    until string.empty?
       if string.size <= width
         lines << string
         string = ""
       else
         index = string[0, width + 1].rindex(/\s/)
-        unless index
-          # let's find the first space we can.
-          index = string.index(/\s/)
-        end
+        index ||= string.index(/\s/)
         if index
           lines << string[0, index]
-          string = string[(index + 1)..-1]
+          string = string[(index + 1)..]
         else
           lines << string
           string = ""
@@ -35,5 +33,4 @@ String.class_eval do
 
     lines
   end
-
-end
+end

data/lib/externals/project.rb

@@ -1,38 +1,42 @@
-require 'externals/extensions/symbol'
 require 'fileutils'
 
 module Externals
-  OPTS_SUFFIXES = ["co", "up", "st", "ex"]  unless const_defined?('OPTS_SUFFIXES')
-  VALID_ATTRIB = ([
-      :name, :path, :repository, :branch, :type, :scm, :revision
-    ]
-  ).map(&:to_s) unless const_defined?('VALID_ATTRIB')
+  OPTS_SUFFIXES = ["co", "up", "st", "ex"].freeze unless const_defined?('OPTS_SUFFIXES')
+  unless const_defined?('VALID_ATTRIB')
+    VALID_ATTRIB = [
+      :name, :path, :repository, :branch, :scm, :revision
+    ].map(&:to_s)
+  end
 
   class Project
     attr_accessor :parent
+
     include FileUtils
     extend FileUtils
 
     def self.attr_attr_accessor *names
       names = [names].flatten
       names.each do |name|
-        define_method name do
-          attributes[name.to_sym]
-        end
         define_method "#{name}=" do |value|
           attributes[name.to_sym] = value
         end
+        next if name == "name" || name == "scm"
+
+        define_method name do
+          attributes[name.to_sym]
+        end
       end
     end
 
-
     attr_attr_accessor Externals::VALID_ATTRIB
     def attributes
       @attributes ||= {}
     end
+
     def name
       attributes[:name] || extract_name(repository)
     end
+
     def main_project?
       path == '.'
     end
@@ -47,25 +51,18 @@ module Externals
       self.class.scm
     end
 
-    def self.default_branch
-      raise "subclass responsibility"
-    end
-
-    def default_branch
-      self.class.default_branch
-    end
-
-    def switch branch_name, options = {}
+    def switch _branch_name, _options = {}
+      # :nocov:
       raise "subclass responsibility"
+      # :nocov:
     end
 
     def initialize hash
       raise "Abstract class" if self.class == Project
       raise "expected hash" unless hash.is_a? Hash
 
-      hash = hash.keys.inject({}) do |new_hash, key|
-        new_hash[key.to_s] = hash[key]
-        new_hash
+      hash = hash.keys.to_h do |key|
+        [key.to_s, hash[key]]
       end
 
       invalid_attrib = hash.keys - Externals::VALID_ATTRIB
@@ -75,25 +72,26 @@ module Externals
           attribute =~ /^\w+_opts(_(#{OPTS_SUFFIXES.join("|")}))?/
         end
         if !invalid_attrib.empty?
+          # :nocov:
           raise "invalid attribute(s): #{invalid_attrib.join(', ')}"
+          # :nocov:
         end
       end
 
       path = hash.delete('path')
 
-      hash.keys.each do |key|
-        send("#{key}=", hash[key])
+      hash.each_pair do |key, value|
+        send("#{key}=", value)
       end
 
-      if path && !path.is_a?(String)
-        path = path.default_path(name)
-      end
       self.path = path
     end
 
     [:co, :ex].each do |method_name|
-      define_method method_name do |args|
+      define_method method_name do
+        # :nocov:
         raise "subclass responsibility"
+        # :nocov:
       end
     end
 
@@ -112,7 +110,7 @@ module Externals
     end
 
     def extract_name repository
-      if repository =~ /\/([\w_-]+)(?:\.git)?$/
+      if repository =~ /\/([\w-]+)(?:\.git)?$/
         $1
       end
     end
@@ -128,11 +126,11 @@ module Externals
       end
 
       exists.each do |proj|
-        assert.call File.exists?(File.join('vendor', 'plugins', proj, 'lib'))
+        assert.call File.exist?(File.join('vendor', 'plugins', proj, 'lib'))
       end
 
       doesnt.each do |proj|
-        assert.call !File.exists?(File.join('vendor', 'plugins', proj, 'lib'))
+        assert.call !File.exist?(File.join('vendor', 'plugins', proj, 'lib'))
       end
     end
 
@@ -153,7 +151,7 @@ module Externals
 
     # create the suffixed versions
     OPTS_SUFFIXES.map do |suffix|
-      name = "scm_opts_#{suffix}"
+      "scm_opts_#{suffix}"
     end.each do |name|
       define_method name do
         values = [
@@ -172,8 +170,9 @@ module Externals
       end
     end
 
-
     def self.inherited child
+      super
+
       child.class_eval do
         def self.scm
           @scm ||= /^([^:]*::)*([^:]+)Project$/.match(name)[2].downcase
@@ -189,24 +188,21 @@ module Externals
         #of the suffixed versions (<scm_name>_opts_co) as well as the project
         #specific ones. (scm_opts, scm_opts_co, etc)
         scm_name = scm
-        Project.__send__(:define_method, "#{scm_name}_opts_raw") do
-          attributes[name.to_sym]
-        end
         #global settings are fetched from the parent project.
         Project.__send__(:define_method, "#{scm_name}_opts") do
           if parent
             parent.__send__("#{scm_name}_opts")
           else
-            attributes["#{scm_name}_opts".to_sym]
+            attributes[:"#{scm_name}_opts"]
           end
         end
         Project.__send__(:define_method, "#{scm_name}_opts=") do |value|
-          attributes["#{scm_name}_opts".to_sym] = value
+          attributes[:"#{scm_name}_opts"] = value
         end
 
         #now we create the suffixed version of the global settings.
         OPTS_SUFFIXES.map do |suffix|
-          name = "#{scm_name}_opts_#{suffix}"
+          "#{scm_name}_opts_#{suffix}"
         end.each do |name|
           #defer to the parent project for these global settings
           Project.__send__(:define_method, name) do
@@ -215,7 +211,7 @@ module Externals
             else
               values = [
                 attributes[name.to_sym],
-                self.send("#{scm_name}_opts")
+                send("#{scm_name}_opts")
               ].compact
 
               if !values.empty?
@@ -231,15 +227,6 @@ module Externals
     end
 
     protected
-    def trim_quotes value
-      if value
-        if [value[0].chr, value[-1].chr] == ['"', '"']
-          value[1..-2]
-        else
-          value
-        end
-      end
-    end
 
     #helper method for converting "co" into "scm_opts_co" and "" into "scm_opts"
     def resolve_opts command = ""
@@ -247,4 +234,4 @@ module Externals
       send("scm_opts#{command}")
     end
   end
-end
+end

data/lib/externals/scms/git_project.rb

@@ -2,11 +2,8 @@ require File.join(File.dirname(__FILE__), '..', 'project')
 
 module Externals
   class GitProject < Project
-    def default_branch
-      'master'
-    end
-
     private
+
     def do_clone command, extra_opts = ""
       opts = resolve_opts(command)
 
@@ -22,25 +19,30 @@ module Externals
       puts(gitclonecmd = "git #{opts} clone #{extra_opts} \"#{repository}\" #{dest}")
       puts `#{gitclonecmd}`
       unless $? == 0
+        # :nocov:
         raise "git clone of #{repository} failed."
+        # :nocov:
       end
     end
 
     public
-    def co *args
+
+    def co *_args
       do_up "co"
     end
 
     private
+
     # make sure you have already entered Dir.chdir(path) in your calling code!
     def branch_exists branch_name
       opts = resolve_opts
-      `git #{opts} branch -a` =~ /^\s*#{branch_name}\s*$/
+      `git #{opts} branch -a` =~ /^[\s*]*#{branch_name}\s*$/
     end
 
     # make sure you have already entered Dir.chdir(path) in your calling code!
 
     public
+
     # this method fetches/pulls/changes branches/changes revisions/changes the oil in your geo metro/brings world peace
     def change_to_branch_revision command = ""
       opts = resolve_opts(command)
@@ -48,16 +50,15 @@ module Externals
       pulled = false
 
       project_path = if path == "."
-        name || "."
-      else
-        path
-      end
+                       name || "."
+                     else
+                       path
+                     end
 
       Dir.chdir project_path do
         do_fetch command
       end
 
-
       if branch
         cb = current_branch
 
@@ -78,7 +79,9 @@ module Externals
               puts `git #{opts} checkout --track -b #{branch} origin/#{branch}`
             end
             unless $? == 0
+              # :nocov:
               raise "Could not checkout origin/#{branch}"
+              # :nocov:
             end
           end
         end
@@ -87,6 +90,7 @@ module Externals
         Dir.chdir project_path do
           `git #{opts} pull`
           raise unless $? == 0
+
           pulled = true
         end
       end
@@ -95,7 +99,9 @@ module Externals
         Dir.chdir project_path do
           puts `git #{opts} checkout #{revision}`
           unless $? == 0
+            # :nocov:
             raise "Could not checkout #{revision}"
+            # :nocov:
           end
         end
       else
@@ -108,29 +114,25 @@ module Externals
       end
     end
 
-    def switch branch_name, options = {}
-      cb = current_branch
-      if cb == branch_name
-        puts "Already on branch #{branch_name}"
-      else
-        # This allows the main project to be checked out to a directory
-        # that doesn't match it's name.
-        Dir.chdir path do
-          # let's see if the branch exists in the remote repository
-          # and if not, fetch it.
-          if !branch_exists("origin/#{branch_name}")
-            puts `git #{scm_opts} fetch`
-          end
+    def switch branch_name, _options = {}
+      # This allows the main project to be checked out to a directory
+      # that doesn't match it's name.
+      Dir.chdir path do
+        # let's see if the branch exists in the remote repository
+        # and if not, fetch it.
+        if !branch_exists("origin/#{branch_name}")
+          puts `git #{scm_opts} fetch`
+        end
 
-          # if the local branch doens't exist, add --track -b
-          if branch_exists(branch_name)
-            puts `git #{scm_opts} checkout #{branch_name}`
-          else
-            puts `git #{resolve_opts("co")} checkout --track -b #{branch_name} origin/#{branch_name}`
-          end
-          unless $? == 0
-            raise "Could not checkout origin/#{branch_name}"
-          end
+        if branch_exists(branch_name)
+          puts `git #{scm_opts} checkout #{branch_name}`
+        else
+          puts `git #{resolve_opts("co")} checkout --track -b #{branch_name}`
+        end
+        unless $? == 0
+          # :nocov:
+          raise "Could not checkout origin/#{branch_name}"
+          # :nocov:
         end
       end
     end
@@ -139,7 +141,7 @@ module Externals
       if revision
         # No clean reliable way to clone something that's not a branch or tag.
         # just call up instead.
-        up *args
+        up(*args)
       else
         clone_opts = "--depth 1"
         if branch
@@ -149,11 +151,12 @@ module Externals
       end
     end
 
-    def up *args
+    def up *_args
       do_up "up"
     end
 
     private
+
     def do_fetch command
       opts = resolve_opts(command)
       `git #{opts} fetch`
@@ -161,29 +164,28 @@ module Externals
     end
 
     def do_up command
-      opts = resolve_opts(command)
-
       project_path = if path == "."
-        name || "." # if no name is specified then we are expected to already be in the right path.
-        # this is a little confusing and should be cleaned up.
-        # When we are doing a checkout, the name is set manually in Ext.checkout.
-        # we are then in the parent directory.
-        # When we are doing an update, the main project has no name.
-        # we are then in the correct directory.
-      else
-        path
-      end
+                       name || "." # if no name is specified then we are expected to already be in the right path.
+                     # this is a little confusing and should be cleaned up.
+                     # When we are doing a checkout, the name is set manually in Ext.checkout.
+                     # we are then in the parent directory.
+                     # When we are doing an update, the main project has no name.
+                     # we are then in the correct directory.
+                     else
+                       path
+                     end
 
       puts "Updating #{path}..."
 
-      if !File.exists? project_path
+      if !File.exist?(project_path)
         do_clone command
       end
       change_to_branch_revision command
     end
 
     public
-    def st *args
+
+    def st *_args
       puts "\nstatus for #{path}:"
       Dir.chdir path do
         puts `git #{scm_opts_st} status`
@@ -196,29 +198,33 @@ module Externals
 
     def self.fill_in_opts opts, main_options, sub_options, options
       opts.on("--git", "-g",
-        Integer,
-        *"same as '--scm git'  Uses git to
+              Integer,
+              *"same as '--scm git'  Uses git to
         checkout/export the main project".lines_by_width(options[:summary_width])
       ) {sub_options[:scm] = main_options[:scm] = 'git'}
     end
 
     def self.detected?
-      File.exists? ".git"
+      File.exist?(".git")
     end
 
     #this is a test helper method
+    # TODO: can we move it to the test suite, then?
     def self.add_all
+      # :nocov:
       puts `git add .`
       raise unless $? == 0
+      # :nocov:
     end
 
     def ignore_contains? path
       text = ignore_text(path)
-      text.split(/\n/).detect {|r| r.strip == path.strip}
+      text.split("\n").detect {|r| r.strip == path.strip}
     end
 
-    def ignore_text(path = nil)
-      return '' unless File.exists? '.gitignore'
+    def ignore_text(_path = nil)
+      return '' unless File.exist?('.gitignore')
+
       retval = ''
       open('.gitignore') do |f|
         retval = f.read
@@ -229,7 +235,7 @@ module Externals
     def ignore_rows(path)
       rows = ignore_text(path) || ''
 
-      rows = rows.split(/\n/)
+      rows = rows.split("\n")
 
       rows.delete_if {|row| row =~ /^\s*$/}
 
@@ -250,14 +256,18 @@ module Externals
 
     def drop_from_ignore path
       ir = ignore_rows(path)
-      rows = ir.select {|row| row.strip != path.strip}
+      rows = ir.reject {|row| row.strip == path.strip}
 
       if rows.size == ir.size
+        # :nocov:
         raise "row not found matching #{path} in .gitignore"
+        # :nocov:
       end
 
       if ir.size - rows.size != 1
+        # :nocov:
         raise "More than one row found matching #{path} in .gitignore"
+        # :nocov:
       end
 
       open('.gitignore', 'w') do |f|
@@ -281,11 +291,10 @@ module Externals
       end
     end
 
-    def extract_name s
-      if s =~ /([^\/:]+?)(?:\.git|\.bundle)?$/
+    def extract_name string
+      if string =~ /([^\/:]+?)(?:\.git|\.bundle)?$/
         $1
       end
     end
-
   end
-end
+end