tcravit_ruby_lib 0.0.8 → 0.2.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 10035a5eb75e32c6e501a23706115d956173a4ad0c1ef200fd788321b903c51f
+  data.tar.gz: '0428138258d21e3df798abb6f4966d1e8910f5c5158818e3bf04ea95a830075c'
+SHA512:
+  metadata.gz: f87829a1df51e1bed94ee6b8caf23db45994567a8a759a2adf7b56cec1001f38e76bc51935a03d257be3252bb18128d1015ced8a957b46673155f66f9ebbc55e
+  data.tar.gz: e9ce8fcc9249239b74a5e4375ed8c05a2c2ec2a0871ced5f2a953ca44158e465da66bf56cbc5abe064ec7f8f732b1193e27af93c86227d506399ebe0822c24e2

data/.ruby-gemset

@@ -0,0 +1 @@
+tcravit_ruby_lib

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.3

data/.travis.yml

@@ -1,2 +1,5 @@
 rvm:
   - 1.9.3
+  - 2.4.3
+  - 2.3.6
+  - 2.2.9

data/README.md

@@ -2,3 +2,22 @@
 
 This gem is a collection of random Ruby stuff I use all over the place and
 am collecting here.
+
+For information about what's here and how to use it, consult the RSpec 
+tests in the spec/ directory.
+
+== License
+
+Copyright 2018, Tammy Cravit.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -1,6 +1,7 @@
 require 'rspec/core/rake_task'
 require "bundler/gem_tasks"
+require "tcravit_ruby_lib/rake_tasks"
 
 RSpec::Core::RakeTask.new('spec')
 
-task :default => [:spec]
+task :default => [:spec]

data/lib/tcravit_ruby_lib/app_banner.rb

@@ -0,0 +1,64 @@
+############################################################################
+# TcravitRubyLib: Random useful stuff for Ruby programming.
+#
+# File        : app_banner.rb
+# Description : Helper function for generating app startup banners for
+#               command line applications/scripts.
+############################################################################
+#  Copyright 2011-2018, Tammy Cravit.
+# 
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+############################################################################
+
+module TcravitRubyLib  #-nodoc-#
+  def self.Banner(opts={})
+    raise ArgumentError, "Name not provided" unless opts.keys.include?("name".to_sym)
+  
+    line_length = 76
+    line_length = opts[:line_length] if opts.keys.include?(:line_length)
+
+    lines = []
+    lines.push("*" * line_length)
+
+    name_line = "#{opts[:name]}"
+    if (opts.keys.include?(:description)) then
+      name_line = name_line + ": " + opts[:description]
+    end
+    lines.push(asterisk_pad(name_line, line_length))
+
+    date_line_parts = []
+    if (opts.keys.include?(:version)) then
+      date_line_parts.push("Version #{opts[:version]}")
+    end
+    if (opts.keys.include?(:date)) then
+      date_line_parts.push(opts[:date])
+    end
+    if (opts.keys.include?(:author)) then
+      date_line_parts.push(opts[:author])
+    end
+    unless date_line_parts.empty?
+      lines.push(asterisk_pad(date_line_parts.join(", ")))
+    end
+
+    lines.push("*" * line_length)
+    
+    return lines.join("\n")
+  end
+
+  def self.asterisk_pad(data, length=76)
+    buf = "* " + (" " * (((length-4) - data.length) / 2)) + data
+    buf = buf + (" " * ((length-2) - buf.length)) + " *"
+    return buf
+  end
+
+end

data/lib/tcravit_ruby_lib/app_config.rb

@@ -1,3 +1,24 @@
+############################################################################
+# TcravitRubyLib: Random useful stuff for Ruby programming.
+#
+# File        : app_config.rb
+# Description : Simple and flexible DSL-like app config storage.
+############################################################################
+#  Copyright 2011-2018, Tammy Cravit.
+# 
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+############################################################################
+
 module TcravitRubyLib #:nodoc:
 
   # Simple and Flexible Configuration Data Storage.
@@ -20,12 +41,6 @@ module TcravitRubyLib #:nodoc:
   #     TcravitRubyLib::AppConfig.some_value = 2048
   #     TcravitRubyLib::AppConfig.some_value     # => 2048
   #      
-  # 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 AppConfig
     extend self

data/lib/tcravit_ruby_lib/config_searcher.rb

@@ -1,3 +1,25 @@
+############################################################################
+# TcravitRubyLib: Random useful stuff for Ruby programming.
+#
+# File        : config_searcher.rb
+# Description : Locate the configuration directory for an app by traversing
+#               the filesystem looking for a .git directory.
+############################################################################
+#  Copyright 2011-2018, Tammy Cravit.
+# 
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+############################################################################
+
 require 'pathname'
 
 module TcravitRubyLib #:nodoc:
@@ -45,7 +67,8 @@ module TcravitRubyLib #:nodoc:
       
       dir = Pathname.new(start_dir)
       app_config_dir = dir + config_dir_name
-      
+     
+      begin
        if dir.children.include?(app_config_dir)
          if only_container_dir
            app_config_dir.to_s.split('/')[0..-2].join('/')
@@ -59,6 +82,9 @@ module TcravitRubyLib #:nodoc:
          # I'm sure there's a better way to do this.
          locate_config_dir(opts.reject{|k,v| k == :start_in}.merge({start_in: dir.parent.to_s}))  
        end      
+      rescue
+        raise ArgumentError, "Start directory \"#{start_dir}\" doesn't exist"
+      end
     end
   end
-end
+end

data/lib/tcravit_ruby_lib/configurable.rb

@@ -0,0 +1,73 @@
+############################################################################
+# TcravitRubyLib: Random useful stuff for Ruby programming.
+#
+# File        : configurable.rb
+# Description : Make a class configurable via a simple DSL
+############################################################################
+#  Copyright 2011-2018, Tammy Cravit.
+# 
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+############################################################################
+
+module TcravitRubyLib    #:nodoc:
+
+# Make a class configurable via a DSL
+#
+# From https://www.toptal.com/ruby/ruby-dsl-metaprogramming-guide
+#
+# Sample Usage:
+#
+# class MyApp
+#   include Configurable.with(:app_id, :title, :cookie_name)
+# 
+#   # ...
+# end
+#
+# SomeClass.configure do
+#   app_id "my_app"
+#   title "My App"
+#   cookie_name { "#{app_id}_session" }
+# end
+
+module Configurable
+  def self.with(*attrs)
+    not_provided = Object.new
+    config_class = Class.new do
+      attrs.each do |attr|
+        define_method attr do |value = not_provided, &block|
+          if value === not_provided && block.nil?
+            result = instance_variable_get("@#{attr}")
+            result.is_a?(Proc) ? instance_eval(&result) : result
+          else
+            instance_variable_set("@#{attr}", block || value)
+          end
+        end
+      end
+      attr_writer *attrs
+    end
+    class_methods = Module.new do
+      define_method :config do
+        @config ||= config_class.new
+      end
+      def configure(&block)
+        config.instance_eval(&block)
+      end
+    end
+    Module.new do
+      singleton_class.send :define_method, :included do |host_class|
+        host_class.extend class_methods
+      end
+    end
+  end
+end
+end

data/lib/tcravit_ruby_lib/on_execute.rb

@@ -1,17 +1,48 @@
-###########################################################################
-# A bit of ruby hackery to enable the script to be run directly 
-# from the command line, as well as included into other code.
-# (Courtesy of elliottcable).
+############################################################################
+# TcravitRubyLib: Random useful stuff for Ruby programming.
 #
-# Not autoloaded by the Gem; require 'tcravit_ruby_lib/on_execute' to pull
-# it in.
-###########################################################################
+# File        : on_execute.rb
+# Description : Make a script both includable and directly runnable
+############################################################################
+#  Copyright 2011-2018, Tammy Cravit.
+# 
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+############################################################################
+
 
 module Kernel
+  #########################################################################
+  # A bit of ruby hackery to enable the script to be run directly 
+  # from the command line, as well as included into other code.
+  # (Courtesy of elliottcable).
+  #
+  # Example:
+  #
+  #    class MyApp
+  #      # ...
+  #      def start()
+  #        #...
+  #      end
+  #    end
+  #
+  #    on_execute do
+  #      MyApp.new().start()
+  #    end 
+  #########################################################################
   def on_execute
     calling_file = caller.first.split(':').first
     if File.expand_path(calling_file) == File.expand_path($0)
       yield
     end
   end
-end
+end

data/lib/tcravit_ruby_lib/rake_tasks.rb

@@ -0,0 +1,36 @@
+############################################################################
+# TcravitRubyLib: Random useful stuff for Ruby programming.
+#
+# File        : rake_tasks.rb
+# Description : Helper for loading shared Rake tasks
+############################################################################
+#  Copyright 2011-2018, Tammy Cravit.
+# 
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+############################################################################
+
+require 'rake'
+
+module TcravitRubyLib
+  class RakeTasks
+    include Rake::DSL if defined?(Rake::DSL)
+
+    def install_tasks
+      Dir["#{File.join(File.dirname(__FILE__), 'tasks')}/**/*.rake"].each do |f|
+        load f
+      end
+    end
+  end
+end
+
+TcravitRubyLib::RakeTasks.new.install_tasks

data/lib/tcravit_ruby_lib/tasks/bump_ver.rake

@@ -0,0 +1,136 @@
+############################################################################
+# Rake tasks to update the version.rb file for a Gem
+# 
+# Version 1.0, 2018-02-01, tammycravit@me.com
+############################################################################
+#  Copyright 2018, Tammy Cravit.
+# 
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+############################################################################
+
+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"]
+    if ver_file.nil?
+      return nil
+    else
+      return ver_file[0]
+    end
+  end
+end
+
+def write_output_to(file, output)
+  open(file, "w") do |f|
+    f.puts(output)
+  end
+end
+
+def create_file_contents(module_name, version_data)
+  buf = "module #{module_name}\n"
+  buf = buf + "\tVERSION_DATA = [" + version_data.join(", ") + "]\n"
+  buf = buf + "\tVERSION = VERSION_DATA.join(\".\")\n"
+  buf = buf + "end\n"
+end
+
+def load_gem_version_file
+  version_file = find_version_file
+  if version_file.nil?
+    raise ArgumentError, "Could not find version file"
+    exit
+  end
+  require version_file
+  return version_file
+end
+
+def find_module_name_from(version_file)
+  module_name = ""
+  File.foreach(version_file) do |l|
+    next if l.match(/^\s*$/)
+    next if l.match(/^\s*\#/)
+    m = l.match(/^\s*module (\S+)\s*$/) 
+    unless  m.nil? 
+      module_name = m[1]
+      break
+    end
+  end
+  return module_name
+end
+
+def update_gem_version_part(index=2, test_mode=false)
+  positions = ['major', 'minor', 'build']
+
+  version_file = load_gem_version_file
+  module_name = find_module_name_from(version_file)
+
+  vd = TcravitRubyLib::VERSION_DATA
+  vd[index] = vd[index] + 1
+
+  if test_mode then
+    write_output_to("/tmp/bump_ver.out", create_file_contents(module_name, vd))
+  else
+    write_output_to(version_file, create_file_contents(module_name, vd))
+  end
+
+  puts "Updated #{positions[index]} number to #{vd[index]}; version is now #{vd.join('.')}" unless test_mode
+end
+
+def set_gem_version(major, minor, build, test_mode=false)
+  version_file = load_gem_version_file
+  module_name = find_module_name_from(version_file)
+
+  vd = [major, minor, build]
+
+  if test_mode then
+    write_output_to("/tmp/bump_ver.out", create_file_contents(module_name, vd))
+  else
+    write_output_to(version_file, create_file_contents(module_name, vd))
+  end
+
+  puts "Forced Gem version to #{vd.join('.')}" unless test_mode
+end
+
+namespace :version do
+  namespace :bump do
+    desc 'Increment the major number of the gem'
+    task :major, [:test_mode] do |t, args|
+      update_gem_version_part 0, args[:test_mode]
+    end
+
+    desc 'Increment the minor number of the gem'
+    task :minor, [:test_mode] do |t, args|
+      update_gem_version_part 1, args[:test_mode]
+    end
+
+    desc 'Increment the build number of the gem'
+    task :build, [:test_mode] do |t, args|
+      update_gem_version_part 2, args[:test_mode]
+    end
+
+    desc "Set the version number to a specific version"
+    task :set, [:major, :minor, :build, :test_mode] do |t, args|
+      major = args[:major] || 1
+      minor = args[:minor] || 0
+      build = args[:build] || 0
+
+      set_gem_version major, minor, build, args[:test_mode]
+    end
+  end
+end

data/lib/tcravit_ruby_lib/utility.rb

@@ -1,11 +1,37 @@
+############################################################################
+# TcravitRubyLib: Random useful stuff for Ruby programming.
+#
+# File        : utility.rb
+# Description : Random small utility functions
+############################################################################
+#  Copyright 2011-2018, Tammy Cravit.
+# 
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+############################################################################
+
+require 'simple-password-gen'
+
 module TcravitRubyLib
   module Utility
     extend self
     
-    def random_alphanumeric(size=16)
-      alphanumerics = [('0'..'9'),('A'..'Z'),('a'..'z')].map {|range| range.to_a}.flatten
-      (0...size).map { alphanumerics[Kernel.rand(alphanumerics.size)] }.join
+    def random_alphanumeric(size=16, pronounceable=false)
+      if pronounceable then
+        return Password.pronounceable(size*2)[0..(size-1)]
+      else
+        return Password.random(size*2)[0..(size-1)]
+      end
     end
     
   end
-end
+end

data/lib/tcravit_ruby_lib/version.rb

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

data/lib/tcravit_ruby_lib.rb

@@ -1,8 +1,32 @@
+############################################################################
+# TcravitRubyLib: Random useful stuff for Ruby programming.
+#
+# File        : tcravit_ruby_lib.rb
+# Description : Main include file for the library; autoloads all its parts
+############################################################################
+#  Copyright 2011-2018, Tammy Cravit.
+# 
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+############################################################################
+
 $:.unshift File.dirname(__FILE__)
 
+# Make sure we load the version definitions first
 require "tcravit_ruby_lib/version"
-require 'tcravit_ruby_lib/config_searcher'
-require 'tcravit_ruby_lib/app_config'
+
+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"
+end
 
 module TcravitRubyLib # :nodoc:
 end