rango 0.0.3 → 0.0.4

data/lib/rango/ext.rb

@@ -1,14 +1,85 @@
-# coding: utf-8
-
-require_relative "ext/class"
-require_relative "ext/attribute"
-require_relative "ext/core_ext"
-require_relative "ext/kernel"
-require_relative "ext/path"
-require_relative "ext/hash"
-require_relative "ext/string"
-require_relative "ext/colored_string"
-require_relative "ext/random"
-require_relative "ext/try"
-require_relative "ext/object_space"
-require_relative "ext/time_dsl"
+# encoding: utf-8
+
+module Kernel
+  # Require all files matching given glob relative to $:
+  #
+  # @author Botanicus
+  # @since 0.0.3
+  # @param [String] library Glob of files to require
+  # @param [Hash] params Optional parameters.
+  # @option params [String, Array<String>] :exclude File or list of files or globs relative to base directory
+  # @raise [LoadError] If base directory doesn't exist
+  # @raise [ArgumentError] If first argument isn't a glob
+  # @return [Array<String>] List of successfully loaded files
+  # @example
+  #   acquire "lib/*"
+  #   acquire "lib/**/*", exclude: "**/*_spec.rb"
+  #   acquire "lib/**/*", exclude: ["**/*_spec.rb", "lib/init.rb"]
+  def acquire(glob, params = Hash.new)
+    base, glob = get_base_and_glob(glob)
+    $:.compact.find do |path|
+      fullpath = File.expand_path(File.join(path, base))
+      if File.directory?(fullpath)
+        return __acquire__(fullpath, glob, params.merge(soft: true))
+      end
+    end
+    raise LoadError, "Directory #{base} doesn't exist in $:"
+  end
+
+  def acquire!(glob, params = Hash.new)
+    self.acquire(glob, params.merge(soft: false))
+  end
+
+  # Require all files matching given glob relative to current file
+  #
+  # @author Botanicus
+  # @since 0.0.3
+  # @param [String] library Glob of files to require
+  # @param [Hash] params Optional parameters.
+  # @option params [String, Array<String>] :exclude File or list of files or globs relative to base directory
+  # @raise [LoadError] If base directory doesn't exist
+  # @raise [ArgumentError] If first argument isn't a glob
+  # @return [Array<String>] List of successfully loaded files
+  # @example
+  #   acquire "lib/*"
+  #   acquire "lib/**/*", exclude: "**/*_spec.rb"
+  #   acquire "lib/**/*", exclude: ["**/*_spec.rb", "lib/init.rb"]
+  def acquire_relative(glob, params = Hash.new)
+    base, glob = get_base_and_glob(glob)
+    path = File.dirname(caller[0].split(":").first)
+    full = File.expand_path(File.join(path, base))
+    raise LoadError, "Directory #{base} doesn't exist in #{path}" unless File.directory?(full)
+    return __acquire__(full, glob, params.merge(soft: true))
+  end
+
+  def acquire_relative!(glob, params = Hash.new)
+    self.acquire_relative(glob, params.merge(soft: false))
+  end
+
+  private
+  def __acquire__(path, glob, params)
+    glob.replace("#{glob}.rb") if glob.eql?("*") || glob.end_with?("/*")
+    files = Dir[File.join(path, glob)]
+    excludes = [params[:exclude]].flatten.compact
+    excludes.map! do |glob|
+      fullpath = File.join(path, glob)
+      File.file?(fullpath) ? fullpath : Dir[fullpath]
+    end
+    excludes = excludes.flatten.compact
+    files.select do |path|
+      if File.file?(path) && !excludes.include?(path)
+        soft_not_loaded = params[:soft] && ! $LOADED_FEATURES.include?(path)
+        load(path) if soft_not_loaded || ! params[:soft]
+        $LOADED_FEATURES.push(path) if soft_not_loaded
+      end
+    end
+  end
+
+  def get_base_and_glob(glob)
+    base, glob = glob.match(/^([^*]+)(.*)$/)[1..2]
+    raise ArgumentError, "You have to provide glob" if glob.empty?
+    return [base, glob]
+  end
+end
+
+acquire_relative "ext/*", exclude: "thor.rb"

data/lib/rango/ext/array.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+class Array
+  # Returns the _only_ element in the array or raise
+  # +IndexError+ if array hasn't exactly one element.
+  #
+  # @author Botanicus
+  # @from Extensions
+  # @since 0.0.3
+  # @raise [IndexError] If array hasn't exactly one element
+  # @return [Object] First (and only) item of the array
+  # @example
+  #   [5].only        # => 5
+  #   [1, 2, 3].only  # => IndexError
+  #   [].only         # => IndexError
+  def only
+    raise IndexError, "Array#only called on non-single-element array" unless self.size == 1
+    self.first
+  end
+end

data/lib/rango/ext/attribute.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: utf-8
 
 # TODO: refactor similar as attr_accessor_with_default from active support
 # see http://noobkit.com/show/ruby/rails/rails-stable/activesupport/module/attr_accessor_with_default.html
@@ -7,6 +7,18 @@ require "extlib"
 
 # default value for attr
 module AttributeMixin
+  # class Array
+  #   private_alias :join
+  #   def join(char)
+  #     puts "New join!"
+  #     __join__(char)
+  #   end
+  # end
+  def private_alias(method)
+    alias_method "__#{method}__", method
+    private "__#{method}__"
+  end
+
   # @since 0.0.1
   # @example
   #   class Post
@@ -137,4 +149,4 @@ Module.send(:include, AttributeMixin)
 #
 # t = Test.new
 # p t.bar
-# p t.hattributes
+# p t.hattributes

data/lib/rango/ext/colored_string.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: utf-8
 
 require "delegate"
 require "extlib"

data/lib/rango/ext/enumerable.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Enumerable
+  # Enumerable#none? is the logical opposite of the builtin method Enumerable#any?. It
+  # returns +true+ if and only if _none_ of the elements in the collection satisfy the
+  # predicate.
+  #
+  # If no predicate is provided, Enumerable#none? returns +true+ if and only if _none_ of the
+  # elements have a true value (i.e. not +nil+ or +false+).
+  #
+  # @author Botanicus
+  # @from Extensions
+  # @since 0.0.3
+  # @yield [block] Block which will be evaluated in Project.setttings object.
+  # @yieldparam [item] Each item of array-like collection
+  # @yieldparam [key, value] Each item of hash-like collection
+  # @option params [String, Array<String>] :exclude File or list of files or globs relative to base directory
+  # @raise [LoadError] If base directory doesn't exist
+  # @raise [ArgumentError] If first argument isn't a glob
+  # @return [Array<String>] List of successfully loaded files
+  # @example
+  #   [].none?                      # => true
+  #   [nil].none?                   # => true
+  #   [5,8,9].none?                 # => false
+  #   (1...10).none? { |n| n < 0 }  # => true
+  #   (1...10).none? { |n| n > 0 }  # => false
+  def none?(&block)
+    not self.any?(&block)
+  end
+end

data/lib/rango/ext/file.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+
+class File
+  # Append given chunks to the existing file or create new one.
+  # It use <tt>IO#puts</tt> for write to given file.
+  #
+  # @author Botanicus
+  # @since 0.0.3
+  # @param [String] file Path to file. You can use <tt>~</tt>, <tt>~user</tt> or similar expressions.
+  # @param [String, Object] *chunks Chunks which will be written to the file
+  # @raise [Errno::ENOENT] If parent directory of given file doesn't exist
+  # @raise [Errno::EACCES] If you don't have permissions to write to given file
+  # @return [String] Expanded path to given file
+  # @example
+  #   File.append "~/.bashrc", source # => "/Users/botanicus/.bashrc"
+  def self.append(file, *chunks)
+    self.write(:puts, "a", file, *chunks)
+  end
+
+  # Append given chunks to the existing file or create new one.
+  # It use <tt>IO#print</tt> for write to given file.
+  #
+  # @author Botanicus
+  # @since 0.0.3
+  # @param [String] file Path to file. You can use <tt>~</tt>, <tt>~user</tt> or similar expressions.
+  # @param [String, Object] *chunks Chunks which will be written to the file
+  # @raise [Errno::ENOENT] If parent directory of given file doesn't exist
+  # @raise [Errno::EACCES] If you don't have permissions to write to given file
+  # @return [String] Expanded path to given file
+  # @example
+  #   File.append "~/.bashrc", source # => "/Users/botanicus/.bashrc"
+  def self.add(file, *chunks)
+    self.write(:print, "a", file, *chunks)
+  end
+
+  # Create new file and write there given chunks.
+  # It use <tt>IO#puts</tt> for write to given file.
+  #
+  # @author Botanicus
+  # @since 0.0.3
+  # @param [String] file Path to file. You can use <tt>~</tt>, <tt>~user</tt> or similar expressions.
+  # @param [String, Object] *chunks Chunks which will be written to the file
+  # @raise [Errno::ENOENT] If parent directory of given file doesn't exist
+  # @raise [Errno::EACCES] If you don't have permissions to write to given file
+  # @return [String] Expanded path to given file
+  # @example
+  #   File.puts "~/.bashrc", source # => "/Users/botanicus/.bashrc"
+  def self.puts(file, *chunks)
+    self.write(:puts, "w", file, *chunks)
+  end
+
+  # Create new file and write there given chunks.
+  # It use <tt>IO#print</tt> for write to given file.
+  #
+  # @author Botanicus
+  # @since 0.0.3
+  # @param [String] file Path to file. You can use <tt>~</tt>, <tt>~user</tt> or similar expressions.
+  # @param [String, Object] *chunks Chunks which will be written to the file
+  # @raise [Errno::ENOENT] If parent directory of given file doesn't exist
+  # @raise [Errno::EACCES] If you don't have permissions to write to given file
+  # @return [String] Expanded path to given file
+  # @example
+  #   File.print "~/.bashrc", source # => "/Users/botanicus/.bashrc"
+  def self.print(file, *chunks)
+    self.write(:print, "w", file, *chunks)
+  end
+
+  # Write data to file with given method.
+  #
+  # @author Botanicus
+  # @since 0.0.3
+  # @param [String] file Path to file. You can use <tt>~</tt>, <tt>~user</tt> or similar expressions.
+  # @param [String, Object] *chunks Chunks which will be written to the file
+  # @raise [Errno::ENOENT] If parent directory of given file doesn't exist
+  # @raise [Errno::EACCES] If you don't have permissions to write to given file
+  # @return [String] Expanded path to given file
+  # @example
+  #   File.write :printf, "w", "~/.bashrc", "%d %04x", 123, 123 # => "/Users/botanicus/.bashrc"
+  def self.write(method, mode, file, *args)
+    self.expand_path(file).tap do |path|
+      self.open(path, mode) { |file| file.send(method, *args) }
+    end
+  end
+end

data/lib/rango/ext/hash.rb

@@ -1,10 +1,105 @@
-# coding: utf-8
+# encoding: utf-8
 
 class Hash
+  # Return duplication of self with all keys non-recursively converted to symbols
+  #
+  # @author Botanicus
+  # @since 0.0.2
+  # @return [Hash] A hash with all keys transformed into symbols
+  def symbolize_keys
+    self.inject(Hash.new) do |result, array|
+      result[array.first.to_sym] = array.last
+      result
+    end
+  end
+
+  # Replace keys in self by coresponding symbols
+  #
+  # @author Botanicus
+  # @since 0.0.2
+  # @return [Hash] A hash with all keys transformed into symbols
+  def symbolize_keys!
+    self.replace(self.symbolize_keys)
+  end
+
+  # Return duplication of self with all keys recursively converted to symbols
+  #
+  # @author Botanicus
+  # @since 0.0.2
+  # @return [Hash] A hash with all keys transformed into symbols even in inner hashes
+  def deep_symbolize_keys
+    self.inject(Hash.new) do |result, array|
+      key, value = array.first, array.last
+      if value.respond_to?(:symbolize_keys)
+        result[key.to_sym] = value.symbolize_keys
+      else
+        result[key.to_sym] = value
+      end
+      result
+    end
+  end
+
+  # Recursively replace keys in self by coresponding symbols
+  #
+  # @author Botanicus
+  # @since 0.0.2
+  # @return [Hash] A hash with all keys transformed into symbols even in inner hashes
+  def deep_symbolize_keys!
+    self.replace(self.deep_symbolize_keys)
+  end
+
+  # Returns the value of self for each argument and deletes those entries.
+  #
+  # @author Botanicus
+  # @since 0.0.2
+  # @param [*args] the keys whose values should be extracted and deleted.
+  # @return [Array<Object>] The values of the provided arguments in corresponding order.
+  # @api public
+  # @example
+  #   hash = {one: 1, two: 2, three: 3}
+  #   hash.extract!(:one, :two) # => [1, 2]
+  #   hash                      # => {:three => 3}
+  def extract!(*args)
+    args.map do |arg|
+      self.delete(arg)
+    end
+  end
+
+  # @author Botanicus
+  # @since 0.0.2
+  # @return [String] A string formatted for HTML attributes
+  # @example
+  #   {class: "inner", id: "post-#{@post.id}"}.to_html_attrs # => "class='inner' id='post-1'"
+  def to_html_attrs
+    self.map { |key, value| "#{key}='#{value}'" }.join(" ")
+  end
+
+  # @author Botanicus
+  # @since 0.0.2
+  # @return [String] A string formatted for URL
+  # @example
+  #   {action: "rate", rating: 2}.to_url_attrs # => "action=rate&rating=2"
   def to_url_attrs
     self.map { |key, value| "#{key}=#{value}" }.join("&")
   end
 
+  # @author Botanicus
+  # @since 0.0.2
+  # @return [String] Merge self into hash given as argument
+  def reverse_merge(another)
+    another.merge(self)
+  end
+
+  # @author Botanicus
+  # @since 0.0.2
+  # @return [String] Replace self by result of merge self into hash given as argument
+  def reverse_merge!(another)
+    self.replace(self.reverse_merge(another))
+  end
+
+  # @author Botanicus
+  # @since 0.0.2
+  # @deprecated
   def to_native
     self.each do |key, value|
       value = case value
@@ -18,4 +113,35 @@ class Hash
     end
     return self
   end
+
+  # Simplier syntax for code such as params[:post] && params[:post][:title]
+  #
+  # @author Jakub Stastny aka Botanicus
+  # @since 0.0.3
+  # @param [Object] First argument is the key of the hash, the second one the key of the inner hash selected by the first key etc.
+  # @return [Object, nil] The value of the most inner hash if found or nil.
+  # @raise [ArgumentError] If you don't specify keys.
+  # @raise [IndexError] If you work with final result as with hash, so basically you are trying to call fetch method on string or whatever.
+  #
+  # @example
+  #   {a: {b: 1}}.get(:a, :b)     # => 1
+  #   {a: {b: 1}}.get(:a, :b, :c) # => IndexError
+  #   {a: {b: 1}}.get(:a, :c)     # => nil
+  def get(*keys)
+    raise ArgumentError, "You must specify at least one key" if keys.empty?
+    keys.inject(self) do |object, key|
+      # Hash#fetch works similar as Hash#[], but [] method is
+      # defined for too many objects, also strings and even numbers
+      if object.respond_to?(:fetch)
+        begin
+          object.fetch(key)
+        # Hash#fetch raise IndexError if key doesn't exist
+        rescue IndexError
+          return nil
+        end
+      else
+        raise IndexError, "Object #{object.inspect} isn't hash-like collection"
+      end
+    end
+  end
 end

data/lib/rango/ext/kernel.rb

@@ -1,4 +1,4 @@
-# coding: utf-8
+# encoding: utf-8
 
 module Kernel
   # @since 0.0.2
@@ -8,31 +8,57 @@ module Kernel
     end
   end
 
+  # os.home
+  def os
+    @os ||= OS.parse
+  end
+
   # @since 0.0.1
   # @example
-  #   try_require "term/ansicolor", "term-ansicolor"
+  #   try_require_gem "term/ansicolor", "term-ansicolor"
   # @param [String] library Library to require.
   # @param [String, @optional] gemname Name of gem which contains required library. Will be used for displaying message.
   # @return [Boolean] True if require was successful, false otherwise.
-  def try_require(library, gemname = library)
-    begin
-      require library
-    rescue LoadError
-      message = "Gem #{gemname} isn't installed. Run sudo gem install #{gemname}."
-      if defined?(Rango.logger)
-        Rango.logger.warn(message)
-        return false
-      else
-        puts(message)
-        return false
-      end
-    end
+  def try_require_gem(library, gemname = library, options = Hash.new)
+    gemname, options = library, gemname if gemname.is_a?(Hash) && options.empty?
+    try_require_gem!(library, gemname, options)
+  rescue LoadError
+    return false
+  end
+
+  # @since 0.0.3
+  def try_require_gem!(library, gemname = library, options = Hash.new)
+    gemname, options = library, gemname if gemname.is_a?(Hash) && options.empty?
+    require library
+  rescue LoadError => exception
+    message  = "Gem #{gemname} isn't installed. Run sudo gem install #{gemname}. (#{exception.inspect})"
+    logger   = Rango.logger.method(options[:level] || :error)
+    callable = defined?(Rango.logger) ? logger : method(:puts)
+    callable.call(message)
+    raise exception
+  end
+
+  # @since 0.0.3
+  def require_gem_or_exit(library, gemname = library, options = Hash.new)
+    gemname, options = library, gemname if gemname.is_a?(Hash) && options.empty?
+    try_require_gem!(library, gemname, options)
+  rescue LoadError
+    exit 1
+  end
+
+  # @since 0.0.3
+  def try_require(library)
+    require "library"
+  rescue LoadError
+    return false
   end
 
   def command(command)
     puts command
     puts %x[#{command}]
   end
+  alias_method :sh,  :command
+  alias_method :run, :command
 
   def quiet(&block)
     old_stdout = STDOUT.dup
@@ -50,9 +76,6 @@ module Kernel
     return returned
   end
 
-
-  # TODO: try_require and try_require_gem (diff require 'readline' vs require 'term/ansicolor')
-
   # for quick inspection
   # @since 0.0.2
   def puts_and_return(*args)
@@ -66,9 +89,3 @@ module Kernel
     return *args
   end
 end
-
-class Class
-  def controller?
-    false
-  end
-end