jeckyl 0.2.7 → 0.3.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTVhZDM0YjllODFmZmViOGFjMmE1YzkwNmEzNDc5ODAwMTE4Y2Q1NA==
+  data.tar.gz: !binary |-
+    Y2E5NWYxZjllYzI5ODE4YTk3MWRkODgxMWQ5NDY4MTQ2MjlmNzRjOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YzY0MTQ5YjNjZWZlZmU2ODFlY2E4Njg0MmYzYjZlODg4MWIzNDQ2MmNiYTVk
+    MzdhN2NmNDZkNmNkZGM0YWJkOTU0YmQ2ZjFjODNhZDlkYzFiNzAyNGEzMDVl
+    MDcyMjFmNjNiZGM5NDJiNmQwZWQwMDYyOGVlMWEzZTk3ZjI4YWE=
+  data.tar.gz: !binary |-
+    MzhhYjQ1MTRiNGMwOGFlZTM2Mjg3OTZkNDQ4YzYzNjQ1N2YyOTY5NDVhNzBi
+    MmUwMWJiMThlYTQ3ZmRjNmIwZmQ4N2Q1MjhlNTRlM2IzZWUwNTE0MmZjMjdm
+    YTViNDYxMjg3ZDcyMjcwOTQwZGFiOTRhN2UwZWNmMDkyMjAzM2Q=

data/Bugs.rdoc

@@ -1,6 +1,18 @@
 === BUGS
 
-[jeckyl-0.2.0 20-Sep-2012]
+[jeckyl-0.3.2 22-Aug-2013]
 
-  Nothing yet...
+  Can use a *arg but it fails to get through method_missing. Would be nice if it could?
+
+[jeckyl-0.3.2 26-July-2013]
+
+  When accessing a newly created options hash, it appears that undefined keys do not return nil/false as expected.
+  If the same request is made again the expected nil is returned.
+  
+    force = options[:force_init] # where :force_init is NOT a key
+    => true
+    force_again = options[:force_init]
+    => false
+    
+  Very strange and unexpected behaviour.
 

data/Gemfile

@@ -1,6 +1,8 @@
 #@markup ruby
 
 # for the command line
-gem 'thor'
-gem 'term-ansicolor'
+# gem 'thor' not any more
+# gem 'term-ansicolor'
+
+gem 'optplus', '>=0.0.6'
 

data/History.txt

@@ -4,13 +4,48 @@
 
 == History
 
+[jeckyl-0.3.7 19-Sep-2013]
+
+  Corrected some minor yard issues
+  
+[jeckyl-0.3.6 11-Sep-2013]
+
+  Added a couple of helpers (an_executable) and removed thor from utility.
+
+[jeckyl-0.3.5 23-Aug-2013]
+
+  Ensure 1.9 compliance
+
+[jeckyl-0.3.4 23-Aug-2013]
+
+  Test for files in merge and ignore if not there
+
+[jeckyl-0.3.3 22-Aug-2013]
+
+  Set :config_files to an empty array by default
+
+[jeckyl-0.3.2 25-Jul-2013]
+
+  Updated merge to merge a hash as well as a file (using Hash#merge!)
+
+[jeckyl-0.3.1 9-Apr-2013]
+
+  Added class method get_config_opt to pre-parse -c cfile from the command line so that
+  the specified config file can then be used for the rest of the options
+
+[jeckyl-0.3.0 29-Mar-2013]
+
+  Beta test. Jeckyl can now process command switches for the same options using optparse.
+  Helper methods moved to a separate module and a couple of new ones added (a_number, a_positive_number).
+  A to_s method added to make it easier to display values.
+
 [jeckyl-0.2.7 15-Nov-2012]
 
   Change base directory for configs to /etc/jerbil consistent with the main jerbil gem
 
 [jeckyl-0.2.6 25-Oct-2012]
 
-  Revert to /etc/jermine while working through changes to over gems
+  Revert to /etc/jermine while working through changes to other gems
 
 [jeckyl-0.2.5 25-Oct-2012]
 

data/bin/jeckyl

@@ -1,9 +1,9 @@
-#!/usr/bin/env ruby18
+#!/usr/bin/env ruby
 #
-# Description
+# Command Line utilities for Jeckyl
 #
 # Author:: Robert Sharp
-# Copyright:: Copyright (c) 2010 Robert Sharp
+# Copyright:: Copyright (c) 2013 Robert Sharp
 # License:: Open Software Licence v3.0
 #
 # This software is licensed for use under the Open Software Licence v. 3.0
@@ -12,36 +12,34 @@
 # must themselves be licensed under the Open Software Licence v. 3.0
 # 
 #
-# replace this to point to your config class
-# require 'my_jeckyl_configurator'
-require 'rubygems' # want to find classes that might be in gems
-require 'jeckyl'
-require 'jeckyl/errors'
-require 'thor'
-require 'thor/group'
-require 'colored'
 
+require 'rubygems'
+require 'optplus'
 
+require 'jeckyl'
+require 'jeckyl/errors'
 
-# the Command Line Interface for jeckyl to allow users to generate
-# config files, generate a simple template or check a config file
-class JeckylCLI < Thor
+class JeckylCli < Optplus::Parser
   
-  default_task :usage
+  usage "action [params] [options]"
   
-  desc "usage", "You are looking at it"
-  def usage
-    puts "Useful tasks for managing Jeckyl config files."
-    puts ""
-    help
-    puts ""
-    puts "See Also:"
-    puts "  README.md: (see jeckyl readme above)"
-    puts "  GitHub: https://github.com/osburn-sharp/jeckyl"
-    puts "  RubyDoc: http://rdoc.info/github/osburn-sharp/jeckyl/frames"
+  description "Useful utilities for Jeckyl configuration files.",
+    "To find out more, type 'jeckyl readme'"
+    
+  # before_all
+  
+  def options(opts)
+    opts.on('-C', '--class Index', Integer, 'select a class by index') do |i|
+      set_option :klass_index, i
+    end
+    opts.on('-k', '--concat', 'concat all classes, starting with the oldest') do
+      set_option :konkat
+    end
   end
   
-  desc "readme", "display the readme file for the gem"
+  # before_actions
+  
+  describe "readme", "display the readme file for the gem"
   def readme
     gem_spec = Gem::Specification.find_by_name('jeckyl')
     readme_path = File.join(gem_spec.gem_dir, 'README.md')
@@ -54,30 +52,36 @@ class JeckylCLI < Thor
 
   end
   
-  desc "list", "list all the config classes involved in a given class"
-  def list(cfile)
+  describe "list", "list all the config classes involved in a given class"
+  def list
+    cfile = next_argument_or_error("missing config class")
     require cfile
     classes = Jeckyl::Options.descendants
     display_classes(classes)
   rescue LoadError
     puts "Error: could not load #{cfile}".red.bold
   end
+  help :list, "Show a list of this config class and its ancestors",
+    "This is useful when you have create a config class from a parent class",
+    "in order to include the parent classes' parameters.",
+    "The list is indexed and the index can be used in other actions,",
+    "include 'jeckyl config'."
     
   
-  desc "config", "generate config file for the given config class"
-  method_option :class, :aliases=>'-C', :type=>:numeric, :desc=>'select class by index'
-  method_option :concat, :aliases=>'-k', :desc=>'concat all classes, starting with the oldest'
-  def config(cfile, my_class_name=nil)
-    
+  
+  describe "config", "generate config file for the given config class"
+  def config
+    cfile = next_argument_or_error("You must provide a config class")
     require cfile # catch LoadError if cfile does not load
     
-    my_class_index = options[:class] || 0 
-    my_class_index += -1 if my_class_index > 0
+    my_class_index = get_option(:klass_index) || 0 
+    my_class_index -= 1 if my_class_index > 0
     
+    konkat = get_option :konkat
     
     classes = Jeckyl::Options.descendants
     
-    if options[:concat].nil? && classes[my_class_index].nil? then
+    if !konkat && classes[my_class_index].nil? then
       $stderr.puts "Index #{my_class_index + 1} is invalid. Please select a valid index".red.bold
       display_classes(classes)
       return false
@@ -86,7 +90,7 @@ class JeckylCLI < Thor
     $stderr.puts "There are #{classes.length} sets of configs, use 'jeckyl list' to list them or -k to generate them all".yellow if classes.length > 1
     
     my_classes = []
-    if options[:concat] then
+    if konkat then
       classes.each_index {|i| my_classes.unshift i}
     else
       my_classes << my_class_index
@@ -100,7 +104,7 @@ class JeckylCLI < Thor
       classes[ci].generate_config(true)
     end
     
-    unless options[:concat] || classes.length == 1
+    unless konkat || classes.length == 1
       puts ""
       puts "# There are also parameters in:"
       classes.each do |klass|
@@ -109,11 +113,24 @@ class JeckylCLI < Thor
     end
 
   rescue LoadError
-    puts "Error: could not load #{cfile}".red.bold
+    if cfile.nil? then
+      puts "Error: you need to specify a configration file".red.bold
+    else
+      puts "Error: could not load #{cfile}".red.bold
+    end
   end
+  help :config, "Outputs a default config file for the given class.",
+    "Use this to create a default file that you can then tailor for",
+    "specific settings. If there is more than one class involved use",
+    "-k to create an output with all the config parameters included.",
+    "Output is to stdout and can easily be redirected to a file as needed."
   
-  desc "klass", "generate a simple class template"
-  def klass(name, parent="Jeckyl::Config")
+  
+  
+  describe "klass", "generate a simple class template"
+  def klass
+    name = next_argument_or_error("missing class name")
+    parent = next_argument_or('Jeckyl::Config')
     puts <<EOTXT
 # Simple framework for defining Jeckyl options to put into a config hash
 
@@ -135,13 +152,20 @@ module #{name}
   end
 end
 EOTXT
-    
+
   end
+  help :klass, "Generate a simple class file as a template for defining your",
+    "own parameters. You can also specify a class to inherit if you want to",
+    "pick up additional parameters. Otherwise the parent will default to",
+    "Jeckyl::Config. Alternatives include Jellog::Config and JerbilService::Config."
         
   
-  desc "check", "check the given config file is valid for the given class"
+  describe "check", "check the given config file is valid for the given class"
   def check(klass_file, conf_file)
     
+    klass_file = next_argument_or_error("missing class name")
+    conf_file = next_argument_or_error("missing config file")
+    
     require klass_file # catch LoadError if cfile does not load
     
     my_class_index = 0 # assume there is only one
@@ -153,23 +177,27 @@ EOTXT
 
   rescue LoadError
     puts "Error: could not load #{cfile}".red
-    
+
   end
+  help :check, "Use the given class (which must be requirable) and check",
+    "that the given config file is OK or show errors if not.",
+    "Useful way to check that a config file works before using it in earnest."
   
-  desc "markdown", "display the comments from a class in markdown format"
-  method_option :class, :aliases=>'-C', :type=>:numeric, :desc=>'select class by index'
-  method_option :concat, :aliases=>'-k', :desc=>'concat all classes, starting with the oldest'
-  def markdown(cfile)
+  
+  describe "markdown", "display the comments from a class in markdown format"
+  def markdown
     
-    require cfile # catch LoadError if cfile does not load
+    cfile = next_argument_or_error("missing class")
     
-    my_class_index = options[:class] || 0 
-    my_class_index += -1 if my_class_index > 0
+    require cfile # catch LoadError if cfile does not load
     
+    my_class_index = get_option(:klass_index) || 0 
+    my_class_index -= 1 if my_class_index > 0
+    konkat = get_option :konkat
     
     classes = Jeckyl::Options.descendants
     
-    if options[:concat].nil? && classes[my_class_index].nil? then
+    if !konkat && classes[my_class_index].nil? then
       $stderr.puts "Index #{my_class_index + 1} is invalid. Please select a valid index".red.bold
       display_classes(classes)
       return false
@@ -178,7 +206,7 @@ EOTXT
     $stderr.puts "There are #{classes.length} sets of configs, use 'jeckyl list' to list them or -k to generate them all".yellow if classes.length > 1
     
     my_classes = []
-    if options[:concat] then
+    if konkat then
       classes.each_index {|i| my_classes << i}
     else
       my_classes << my_class_index
@@ -225,7 +253,7 @@ EOTXT
       end
     end
     
-    unless options[:concat] || classes.length == 1
+    unless konkat || classes.length == 1
       puts ""
       puts "## See Also"
       puts ""
@@ -240,8 +268,11 @@ EOTXT
     puts "Error: could not load #{cfile}".red
     
   end
+  help :markdown, "Similar to config but instead of creating the config file itself",
+    "this creates a markdown file that can be used in rdoc to describe the config",
+    "parameters."
   
-  no_tasks do
+
   def display_classes(classes)
     $stderr.puts "The following classes are available:".green
     count = 1
@@ -250,8 +281,9 @@ EOTXT
       count += 1
     end
   end
-  end
 
+
+  
 end
 
-JeckylCLI.start
+JeckylCli.run!

data/bin/jeckyl-old

@@ -0,0 +1,259 @@
+#!/usr/bin/env ruby
+#
+# Description
+#
+# Author:: Robert Sharp
+# Copyright:: Copyright (c) 2010 Robert Sharp
+# License:: Open Software Licence v3.0
+#
+# This software is licensed for use under the Open Software Licence v. 3.0
+# The terms of this licence can be found at http://www.opensource.org/licenses/osl-3.0.php
+# and in the file copyright.txt. Under the terms of this licence, all derivative works
+# must themselves be licensed under the Open Software Licence v. 3.0
+# 
+#
+# replace this to point to your config class
+# require 'my_jeckyl_configurator'
+require 'rubygems' # want to find classes that might be in gems
+require 'jeckyl'
+require 'jeckyl/errors'
+require 'thor'
+require 'thor/group'
+require 'colored'
+
+
+
+# the Command Line Interface for jeckyl to allow users to generate
+# config files, generate a simple template or check a config file
+class JeckylCLI < Thor
+  
+  default_task :usage
+  
+  class_option :gem, :aliases=>'-g', :type=>:string, :desc=>'get config classes etc from the given gem'
+  
+  desc "usage", "You are looking at it"
+  def usage
+    puts "Useful tasks for managing Jeckyl config files."
+    puts ""
+    help
+    puts ""
+    puts "See Also:"
+    puts "  README.md: (see jeckyl readme above)"
+    puts "  GitHub: https://github.com/osburn-sharp/jeckyl"
+    puts "  RubyDoc: http://rdoc.info/github/osburn-sharp/jeckyl/frames"
+  end
+  
+  desc "readme", "display the readme file for the gem"
+  def readme
+    gem_spec = Gem::Specification.find_by_name('jeckyl')
+    readme_path = File.join(gem_spec.gem_dir, 'README.md')
+    
+    File.open(readme_path) do |rfile|
+      rfile.each_line do |rline|
+        puts rline
+      end
+    end
+
+  end
+  
+  desc "list", "list all the config classes involved in a given class"
+  def list(cfile)
+    require cfile
+    classes = Jeckyl::Options.descendants
+    display_classes(classes)
+  rescue LoadError
+    puts "Error: could not load #{cfile}".red.bold
+  end
+    
+  
+  desc "config", "generate config file for the given config class"
+  method_option :class, :aliases=>'-C', :type=>:numeric, :desc=>'select class by index'
+  method_option :concat, :aliases=>'-k', :desc=>'concat all classes, starting with the oldest'
+  def config(cfile, my_class_name=nil)
+    
+    require cfile # catch LoadError if cfile does not load
+    
+    my_class_index = options[:class] || 0 
+    my_class_index += -1 if my_class_index > 0
+    
+    
+    classes = Jeckyl::Options.descendants
+    
+    if options[:concat].nil? && classes[my_class_index].nil? then
+      $stderr.puts "Index #{my_class_index + 1} is invalid. Please select a valid index".red.bold
+      display_classes(classes)
+      return false
+    end
+    
+    $stderr.puts "There are #{classes.length} sets of configs, use 'jeckyl list' to list them or -k to generate them all".yellow if classes.length > 1
+    
+    my_classes = []
+    if options[:concat] then
+      classes.each_index {|i| my_classes.unshift i}
+    else
+      my_classes << my_class_index
+    end
+    
+    my_classes.each do |ci|
+      puts "#"
+      puts "# Configuration Options for: #{classes[ci].name}"
+      puts "#"
+      puts
+      classes[ci].generate_config(true)
+    end
+    
+    unless options[:concat] || classes.length == 1
+      puts ""
+      puts "# There are also parameters in:"
+      classes.each do |klass|
+        puts "#  #{klass.name}"unless klass == classes[my_class_index]
+      end
+    end
+
+  rescue LoadError
+    puts "Error: could not load #{cfile}".red.bold
+  end
+  
+  desc "klass", "generate a simple class template"
+  def klass(name, parent="Jeckyl::Config")
+    puts <<EOTXT
+# Simple framework for defining Jeckyl options to put into a config hash
+
+module #{name}
+  
+  # configuration parameters for #{name} 
+  #
+  # @see file:<PATH_TO_CONFIG_MARKDOWN_FILE> #{name} Parameter Descriptions
+  #
+  class Config < #{parent}
+    
+    def configure_a_parameter(val)
+      default "default"
+      comment "Comment line",
+        "more comments"
+      a_type_of(String)
+    end
+    
+  end
+end
+EOTXT
+    
+  end
+        
+  
+  desc "check", "check the given config file is valid for the given class"
+  def check(klass_file, conf_file)
+    
+    require klass_file # catch LoadError if cfile does not load
+    
+    my_class_index = 0 # assume there is only one
+    
+    classes = Jeckyl::Options.descendants
+    
+    
+    classes[my_class_index].check_config(conf_file)
+
+  rescue LoadError
+    puts "Error: could not load #{cfile}".red
+    
+  end
+  
+  desc "markdown", "display the comments from a class in markdown format"
+  method_option :class, :aliases=>'-C', :type=>:numeric, :desc=>'select class by index'
+  method_option :concat, :aliases=>'-k', :desc=>'concat all classes, starting with the oldest'
+  def markdown(cfile)
+    
+    require cfile # catch LoadError if cfile does not load
+    
+    my_class_index = options[:class] || 0 
+    my_class_index += -1 if my_class_index > 0
+    
+    
+    classes = Jeckyl::Options.descendants
+    
+    if options[:concat].nil? && classes[my_class_index].nil? then
+      $stderr.puts "Index #{my_class_index + 1} is invalid. Please select a valid index".red.bold
+      display_classes(classes)
+      return false
+    end
+    
+    $stderr.puts "There are #{classes.length} sets of configs, use 'jeckyl list' to list them or -k to generate them all".yellow if classes.length > 1
+    
+    my_classes = []
+    if options[:concat] then
+      classes.each_index {|i| my_classes << i}
+    else
+      my_classes << my_class_index
+    end
+    
+    first = true
+    sublevel = 2
+    
+    my_classes.each do |ci|
+      my_class = classes[ci]
+      my_configurator = my_class.new(nil, :local=>true)
+      
+      if first then
+        puts "# #{my_class.name} Parameters"
+        puts ""
+        puts "The following parameters are defined in {#{my_class.name}} and should be used"
+        puts "in a configuration file. A default config file can be generated using:"
+        puts ""
+        puts "    jeckyl config #{cfile}"
+      else
+        puts "## Additional Parameters from #{my_class.name}"
+        puts ""
+        puts "The following additional parameters are defined in #{my_class.name}, which"
+        puts "is an ancestor of this config class. See separate documentation for more details."
+        sublevel = 3
+      end
+      first = false
+      puts ""
+      
+      puts "#" * sublevel + " Parameters"
+      puts ""
+      
+      my_configurator.comments.each do |param, comment|
+        puts " * **#{param}**"
+        puts " "
+        comment.each {|line| puts "    #{line}"}
+        puts ""
+        if my_configurator.defaults.has_key?(param) then
+          puts "    Default: #{my_configurator.defaults[param].inspect}"
+        else
+          puts "    No default set"
+        end
+        puts ""
+      end
+    end
+    
+    unless options[:concat] || classes.length == 1
+      puts ""
+      puts "## See Also"
+      puts ""
+      puts "There are also parameters in:"
+      puts ""
+      classes.each do |klass|
+        puts " * #{klass.name}"unless klass == classes[my_class_index]
+      end
+    end
+
+  rescue LoadError
+    puts "Error: could not load #{cfile}".red
+    
+  end
+  
+  no_tasks do
+  def display_classes(classes)
+    $stderr.puts "The following classes are available:".green
+    count = 1
+    classes.each do |klass|
+      $stderr.puts   "  #{count}. #{klass.name}"
+      count += 1
+    end
+  end
+  end
+
+end
+
+JeckylCLI.start