tcravit_ruby_lib 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10035a5eb75e32c6e501a23706115d956173a4ad0c1ef200fd788321b903c51f
-  data.tar.gz: '0428138258d21e3df798abb6f4966d1e8910f5c5158818e3bf04ea95a830075c'
+  metadata.gz: 99beb5b023dc1d79ac40040e472823a0c930a60c9675fc7915efa3fd9be6c4b5
+  data.tar.gz: 5c663f58eb23d5530476bbdf3d7551f4fe36b01649f5063047b55f2f4acc2e9b
 SHA512:
-  metadata.gz: f87829a1df51e1bed94ee6b8caf23db45994567a8a759a2adf7b56cec1001f38e76bc51935a03d257be3252bb18128d1015ced8a957b46673155f66f9ebbc55e
-  data.tar.gz: e9ce8fcc9249239b74a5e4375ed8c05a2c2ec2a0871ced5f2a953ca44158e465da66bf56cbc5abe064ec7f8f732b1193e27af93c86227d506399ebe0822c24e2
+  metadata.gz: f80ddab2f052a5042fd3ee8be67d00d71010611e7ca4e3b04e686d8fad808f886ff9a8be0f6e1fe4f8bcc59260ff16a4a687505668743d3db96529c7d427761d
+  data.tar.gz: 41012afc7344c3fbf42fdb1d8d3d0e6ddf751b23da64e7c431a81fd5103dfd24dda7c9b4f7d4a778c1995a08b5a2eed2afe6a3941dad851c24321a2cf19261c4

data/lib/tcravit_ruby_lib.rb

@@ -24,8 +24,8 @@ $:.unshift File.dirname(__FILE__)
 # Make sure we load the version definitions first
 require "tcravit_ruby_lib/version"
 
-Dir[File.join(File.dirname(__FILE__), "tcravit_ruby_lib", "*.rb")].each do |f|
-  require File.join("tcravit_ruby_lib", File.basename(f)) unless File.basename(f) == "version.rb"
+Dir[File.join(File.dirname(__FILE__), "tcravit_ruby_lib", "*.rb")].reject { |x| File.basename(x) == "version.rb" }.each do |f|
+  require File.join("tcravit_ruby_lib", File.basename(f)) 
 end
 
 module TcravitRubyLib # :nodoc:

data/lib/tcravit_ruby_lib/app_banner.rb

@@ -20,8 +20,50 @@
 #  limitations under the License.
 ############################################################################
 
-module TcravitRubyLib  #-nodoc-#
-  def self.Banner(opts={})
+module TcravitRubyLib #-nodoc-#  
+
+  extend self
+
+  ##
+  # Generate an app startup banner for a command-line application.
+  #
+  # == Banner Formatting
+  #
+  # The app banner will be framed with asterisks. By default, it will be 76
+  # characters long, though this can be overridden by passing in a value for
+  # +line_length+.
+  #
+  # If a +description+ is included, the first text line of the banner will
+  # take the form "name: description"; otherwise, just the name will be
+  # output. This line will be centered, with whitespace added to the ends to
+  # make the asterisks line up. Otherwise, just the app name will be output.
+  #
+  # If any of +version+, +date+, and/or +author+ are supplied, these will be
+  # joined (in that order) by commas, and a second centered line of text
+  # containing those components will be output. If none are supplied, no
+  # second line will be output.
+  #
+  # == Arguments
+  #
+  # For flexibility, parameters are all passed in a hash. The method accepts
+  # the following options:
+  #
+  # * `:name` - The name of the application. Required.
+  # * `:description` - A brief description of the application. Optional.
+  # * `:version`
+  # * `:date`
+  # * `:author`
+  # * `:line_length`
+  #
+  # The only required option is +name+, and an ArgumentError will be raised
+  # if it is not supplied. All other options are optional, and the method
+  # will simply use whichever ones are supplied to generate the banner.
+  #
+  # For examples, see the RSpec tests for this method.
+  #
+  # @param opts [Hash] A hash of options.
+  # @return [String] The app banner, ready to print out
+  def Banner(opts={})
     raise ArgumentError, "Name not provided" unless opts.keys.include?("name".to_sym)
   
     line_length = 76
@@ -55,7 +97,8 @@ module TcravitRubyLib  #-nodoc-#
     return lines.join("\n")
   end
 
-  def self.asterisk_pad(data, length=76)
+  private 
+  def asterisk_pad(data, length=76)
     buf = "* " + (" " * (((length-4) - data.length) / 2)) + data
     buf = buf + (" " * ((length-2) - buf.length)) + " *"
     return buf

data/lib/tcravit_ruby_lib/app_config.rb

@@ -21,7 +21,8 @@
 
 module TcravitRubyLib #:nodoc:
 
-  # Simple and Flexible Configuration Data Storage.
+  ##
+  ## Simple and Flexible Configuration Data Storage.
   #
   # AppConfig provides a simple facility for storing configuration data in
   # an application. It does this using metaprogramming techniques to define
@@ -44,7 +45,28 @@ module TcravitRubyLib #:nodoc:
   
   module AppConfig
     extend self
-    
+   
+    ##
+    # Configure the settings.
+    #
+    # +configure+ accepts a block which is evaluated by `instance_eval`. 
+    # Method calls inside this block are turned into app settings via
+    # {#method_missing}, which dynamically creates getters and setters
+    # for the provided values.
+    #
+    # As a side effect, this means you can't create app settings whose
+    # name is the same as a ruby reserved word or a method defined by a
+    # ruby `Object`, because those calls don't trigger {#method_missing}
+    # to execute. In practice, this shouldn't be a huge limitation, but
+    # it's worth being aware of.
+    #
+    # Configuration setting names must begin with an uppercase letter, 
+    # lowercase letter, or digit. Dashes and underscores are permitted
+    # after the initial character.
+    #
+    # @param block [Block] The configuration block.
+    # @return Nothing, but stores the configuration values provided
+    #         inside the block.
     def configure(&block)
       @definitions ||= Hash.new
 
@@ -54,14 +76,27 @@ module TcravitRubyLib #:nodoc:
       instance_eval &block
       @in_config = false
     end
-    
+   
+    #@
+    # Remove a previously defined configuration value.
+    #
+    # {#remove} can be passed the name of the configuration setting as 
+    # a string or a symbol. If the requested setting exists, its value
+    # will be discarded, and the getter and setter methods will be
+    # undefined. If the requested setting does not exist, no action is 
+    # taken and no exceptions are raised.
+    #
+    # @param key [String] The configuration setting to remove. A symbol
+    # can also be provided for the +key+.
+    # @return Nothing.
     def remove!(key)
       the_sym = key.to_sym
-      @definitions.delete(the_sym)
-      send :undef_method, the_sym
-      send :undef_method, "#{the_sym.to_s}=".to_sym      
+      @definitions.delete(the_sym) if @definitions.include?(the_sym)
+      send :undef_method, the_sym if self.respond_to?(the_sym)
+      send :undef_method, "#{the_sym.to_s}=".to_sym if self.respond_to?("#{the_sym.to_s}=".to_sym)
     end
-    
+   
+    #-nodoc-#
     def method_missing(methname, *args)
       if (methname.to_s =~ /^([A-Za-z0-9][A-Za-z0-9\-\_]+)$/)
         if @in_config

data/lib/tcravit_ruby_lib/config_searcher.rb

@@ -24,7 +24,8 @@ require 'pathname'
 
 module TcravitRubyLib #:nodoc:
 
-  # Utilities for locating a configuration directory within a tree.
+  ##
+  # jUtilities for locating a configuration directory within a tree.
   #
   # Unix utilities such as +git+ will look for the .git directory in a 
   # project by starting with the current directory and traversing upward
@@ -33,13 +34,6 @@ module TcravitRubyLib #:nodoc:
   #
   # This module, inspired by a post on Practicing Ruby, implements that 
   # kind of traversal for Ruby applications.
-  #
-  # Author:: Tammy Cravit (mailto:tammy@tammycravit.com)
-  # Copyright:: Copyright (c) 2011, Tammy Cravit. All rights reserved.
-  # License:: This program is free software: you can redistribute it and/or modify
-  #           it under the terms of the GNU General Public License as published by
-  #           the Free Software Foundation, either version 3 of the License, or
-  #           (at your option) any later version.  
   module ConfigSearcher
 
     # Locate a configuration folder by starting in the specified directory

data/lib/tcravit_ruby_lib/configurable.rb

@@ -40,6 +40,8 @@ module TcravitRubyLib    #:nodoc:
 # end
 
 module Configurable
+
+  # +nodoc+
   def self.with(*attrs)
     not_provided = Object.new
     config_class = Class.new do

data/lib/tcravit_ruby_lib/rake_tasks.rb

@@ -22,6 +22,11 @@
 require 'rake'
 
 module TcravitRubyLib
+  ##
+  # Load and install rake tasks defined within the TcravitRubyLib library.
+  #
+  # This module is designed to be require'd by a Rakefile, and will load and
+  # install all of the Rake tasks contained within the library.
   class RakeTasks
     include Rake::DSL if defined?(Rake::DSL)
 

data/lib/tcravit_ruby_lib/tasks/bump_ver.rake

@@ -19,16 +19,9 @@
 ############################################################################
 
 def find_version_file
-  curr_dir = File.dirname(__FILE__)
-  while File.exist?(File.join(curr_dir, "Rakefile")) == false
-    if curr_dir == "/"
-      return nil
-    else
-      curr_dir = File.expand_path(curr_dir + "/..")
-    end
-  end
-  if File.directory?(File.join(curr_dir)) then
-    ver_file = Dir["#{curr_dir}/**/version.rb"]
+  rake_dir = Rake.original_dir
+  if File.directory?(rake_dir) then
+    ver_file = Dir["#{rake_dir}/**/version.rb"]
     if ver_file.nil?
       return nil
     else
@@ -82,9 +75,15 @@ def update_gem_version_part(index=2, test_mode=false)
 
   vd = TcravitRubyLib::VERSION_DATA
   vd[index] = vd[index] + 1
+  if (index < 2)
+    vd[2] = 0
+  end
+  if (index == 0)
+    vd[1] = 0
+  end
 
   if test_mode then
-    write_output_to("/tmp/bump_ver.out", create_file_contents(module_name, vd))
+    write_output_to("/tmp/bump_ver_#{positions[index]}.out", create_file_contents(module_name, vd))
   else
     write_output_to(version_file, create_file_contents(module_name, vd))
   end
@@ -99,7 +98,7 @@ def set_gem_version(major, minor, build, test_mode=false)
   vd = [major, minor, build]
 
   if test_mode then
-    write_output_to("/tmp/bump_ver.out", create_file_contents(module_name, vd))
+    write_output_to("/tmp/bump_ver_set.out", create_file_contents(module_name, vd))
   else
     write_output_to(version_file, create_file_contents(module_name, vd))
   end

data/lib/tcravit_ruby_lib/utility.rb

@@ -22,9 +22,23 @@
 require 'simple-password-gen'
 
 module TcravitRubyLib
+  ##
+  # Contains random Ruby utility functions that don't fit anywhere else.
   module Utility
     extend self
     
+    ##
+    # Generate random alphanumeric passwords.
+    #
+    # Previously this method generated passwords by shuffling characters
+    # in an array. It's now  just a wrapper for the +simple-password-gen+
+    # gem.
+    #
+    # @param size [Integer] The length of the password to generate. Defaults
+    # to 16 characters if not specified.
+    # @param pronounceable [Boolean] True to generate pronounceable passwords.
+    # Defaults to false.
+    # @return [String] The generated password.
     def random_alphanumeric(size=16, pronounceable=false)
       if pronounceable then
         return Password.pronounceable(size*2)[0..(size-1)]

data/lib/tcravit_ruby_lib/version.rb

@@ -1,4 +1,4 @@
 module TcravitRubyLib
-	VERSION_DATA = [0, 2, 7]
+	VERSION_DATA = [0, 2, 8]
 	VERSION = VERSION_DATA.join(".")
 end

data/spec/version_bump_rake_tasks_spec.rb

@@ -28,112 +28,129 @@ require_custom_matcher_named("be_a_rake_task_named")
 require_custom_matcher_named("be_a_valid_gem_version_file_for")
 require_custom_matcher_named("declare_the_gem_version_to_be")
 
-TEST_VERSION_FILE = "/tmp/bump_ver.out"
+@test_version_file = "/tmp/bump_ver.out"
 
-describe "version:bump:major", type: :rake do
-  context "the basics" do 
-    it "should be a rake task" do
-      expect(subject).to be_a_rake_task_named("version:bump:major")
+describe "bump_ver.rake" do 
+  describe "version:bump:major", type: :rake do
+    before(:all) do
+      @test_version_file = "/tmp/bump_ver_major.out"
     end
-  end
 
-  context "file generation" do
-    before(:each) do
-      File.delete(TEST_VERSION_FILE) if File.exist?("/tmp/bump_ver.out")
+    context "the basics" do 
+      it "should be a rake task" do
+        expect(subject).to be_a_rake_task_named("version:bump:major")
+      end
     end
 
-    it "should generate a file with the right format and module name" do
-      args = to_task_arguments(1)
-      task.execute(args)
-      expect(TEST_VERSION_FILE).to be_a_valid_gem_version_file_for("TcravitRubyLib")
-    end
+    context "file generation" do
+      before(:each) do
+        File.delete(@test_version_file) if File.exist?(@test_version_file)
+      end
 
-    it "should increment the major version number" do
-      initial_version = TcravitRubyLib::VERSION_DATA.clone
-      args = to_task_arguments(1)
-      task.execute(args)
-      expect(TEST_VERSION_FILE).to declare_the_gem_version_to_be((initial_version[0] + 1), initial_version[1], initial_version[2])
-    end
-  end
-end
+      it "should generate a file with the right format and module name" do
+        args = to_task_arguments(1)
+        task.execute(args)
+        expect(@test_version_file).to be_a_valid_gem_version_file_for("TcravitRubyLib")
+      end
 
-describe "version:bump:minor", type: :rake do
-  context "the basics" do 
-    it "should be a rake task" do
-      expect(subject).to be_a_rake_task_named("version:bump:minor")
+      it "should increment the major version number" do
+        initial_version = TcravitRubyLib::VERSION_DATA.clone
+        args = to_task_arguments(1)
+        task.execute(args)
+        expect(@test_version_file).to declare_the_gem_version_to_be((initial_version[0] + 1), 0, 0)
+      end
     end
   end
 
-  context "file generation" do
-    before(:each) do
-      File.delete(TEST_VERSION_FILE) if File.exist?("/tmp/bump_ver.out")
+  describe "version:bump:minor", type: :rake do
+    before(:all) do
+      @test_version_file = "/tmp/bump_ver_minor.out"
     end
 
-    it "should generate a file with the right format and module name" do
-      args = to_task_arguments(1)
-      task.execute(args)
-      expect(TEST_VERSION_FILE).to be_a_valid_gem_version_file_for("TcravitRubyLib")
+    context "the basics" do 
+      it "should be a rake task" do
+        expect(subject).to be_a_rake_task_named("version:bump:minor")
+      end
     end
 
-    it "should increment the minor version number" do
-      initial_version = TcravitRubyLib::VERSION_DATA.clone
-      args = to_task_arguments(1)
-      task.execute(args)
-      expect(TEST_VERSION_FILE).to declare_the_gem_version_to_be(initial_version[0], (initial_version[1] + 1), initial_version[2])
-    end
-  end
-end
+    context "file generation" do
+      before(:each) do
+        File.delete(@test_version_file) if File.exist?(@test_version_file)
+      end
 
-describe "version:bump:build", type: :rake do
-  context "the basics" do 
-    it "should be a rake task" do
-      expect(subject).to be_a_rake_task_named("version:bump:build")
+      it "should generate a file with the right format and module name" do
+        args = to_task_arguments(1)
+        task.execute(args)
+        expect(@test_version_file).to be_a_valid_gem_version_file_for("TcravitRubyLib")
+      end
+
+      it "should increment the minor version number" do
+        initial_version = TcravitRubyLib::VERSION_DATA.clone
+        args = to_task_arguments(1)
+        task.execute(args)
+        expect(@test_version_file).to declare_the_gem_version_to_be(initial_version[0], (initial_version[1] + 1), 0) 
+      end
     end
   end
 
-  context "file generation" do
-    before(:each) do
-      File.delete(TEST_VERSION_FILE) if File.exist?("/tmp/bump_ver.out")
+  describe "version:bump:build", type: :rake do
+    before(:all) do
+      @test_version_file = "/tmp/bump_ver_build.out"
     end
 
-    it "should generate a file with the right format and module name" do
-      args = to_task_arguments(1)
-      task.execute(args)
-      expect(TEST_VERSION_FILE).to be_a_valid_gem_version_file_for("TcravitRubyLib")
+    context "the basics" do 
+      it "should be a rake task" do
+        expect(subject).to be_a_rake_task_named("version:bump:build")
+      end
     end
 
-    it "should increment build version number" do
-      initial_version = TcravitRubyLib::VERSION_DATA.clone
-      args = to_task_arguments(1)
-      task.execute(args)
-      expect(TEST_VERSION_FILE).to declare_the_gem_version_to_be(initial_version[0], initial_version[1], (initial_version[2] + 1))
-    end
-  end
-end
+    context "file generation" do
+      before(:each) do
+        File.delete(@test_version_file) if File.exist?(@test_version_file)
+      end
 
-describe "version:bump:set", type: :rake do
-  context "the basics" do 
-    it "should be a rake task" do
-      expect(subject).to be_a_rake_task_named("version:bump:set")
+      it "should generate a file with the right format and module name" do
+        args = to_task_arguments(1)
+        task.execute(args)
+        expect(@test_version_file).to be_a_valid_gem_version_file_for("TcravitRubyLib")
+      end
+
+      it "should increment build version number" do
+        initial_version = TcravitRubyLib::VERSION_DATA.clone
+        args = to_task_arguments(1)
+        task.execute(args)
+        expect(@test_version_file).to declare_the_gem_version_to_be(initial_version[0], initial_version[1], (initial_version[2] + 1))
+      end
     end
   end
 
-  context "file generation" do
-    before(:each) do
-      File.delete(TEST_VERSION_FILE) if File.exist?("/tmp/bump_ver.out")
+  describe "version:bump:set", type: :rake do
+    before(:all) do
+      @test_version_file = "/tmp/bump_ver_set.out"
     end
 
-    it "should generate a file with the right format and module name" do
-      args = to_task_arguments(3,4,5,11)
-      task.execute(args)
-      expect(TEST_VERSION_FILE).to be_a_valid_gem_version_file_for("TcravitRubyLib")
+    context "the basics" do 
+      it "should be a rake task" do
+        expect(subject).to be_a_rake_task_named("version:bump:set")
+      end
     end
 
-    it "should generate a file with the right version number" do
-      args = to_task_arguments(3,4,5,1)
-      task.execute(args)
-      expect(TEST_VERSION_FILE).to declare_the_gem_version_to_be(3, 4, 5)
+    context "file generation" do
+      before(:each) do
+        File.delete(@test_version_file) if File.exist?(@test_version_file)
+      end
+
+      it "should generate a file with the right format and module name" do
+        args = to_task_arguments(3,4,5,11)
+        task.execute(args)
+        expect(@test_version_file).to be_a_valid_gem_version_file_for("TcravitRubyLib")
+      end
+
+      it "should generate a file with the right version number" do
+        args = to_task_arguments(3,4,5,1)
+        task.execute(args)
+        expect(@test_version_file).to declare_the_gem_version_to_be(3, 4, 5)
+      end
     end
   end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tcravit_ruby_lib
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Tammy Cravit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-05 00:00:00.000000000 Z
+date: 2018-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple-password-gen