yarrow 0.1.1 → 0.1.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YmMzMjJjMDhjYWU1NGZkYzc0Mzg2ODBiYTViOGZiMzllZTUxYWQ3Ng==
+    MDc1MGQ3ZDI2ZWZjYjdmNDllZjJjODQ0ZTAwODE3OTgxOWNlYWZlYg==
   data.tar.gz: !binary |-
-    MzBjMmJhMGI4MDFhZTU4NmYzYWFhYzAwZjM4ZDY3MjcxZTM1NGNmYg==
+    ZGY5MzUyYzJmYmQxYWE2NTNkZTM0ODIyMjU4MDY0Mzg2MDkwYzZjNw==
 SHA512:
   metadata.gz: !binary |-
-    NTRiNzQ0OTg5ZmM5NzA1N2VmN2UzMTI2N2YwMTVjYmJmYjkzODQ1M2Y4OWRl
-    YzAyYTMyNzQ1NWRiZWE3YzgwM2NiNGQ2ZjI0MjUwMjFkYmFjNTA4NWRmYmYw
-    YWM2N2I1YTVjNWFkMTllNTJiOGE3NjY3MTE0MjU4Njg2MDFiNDY=
+    ZWFiOWVjNDI4ZGYwNTJlMTMxYzRmYTk3YWI1MjI3MWU5Yjk5ZjUwMzBmY2Jl
+    OGJlNmIxMzJhOGUwMTQ1MmEzZGJjZDBlNjUyODI3ZGQwMzEyMDQ5NTgxZTcz
+    MjE4OTcwMGU3M2Y0YTQ4NzBkMjY0OWI3MDViNjE4NDliMTY3ZjI=
   data.tar.gz: !binary |-
-    ZjMxODQ2ZDBjZjY3M2QzMDRmOTdkMDNhYjE2N2U5NjNjMzAxNjcyNWQxNWI4
-    OTU4N2MzMWY2YTEzMDNkOWMzODFhMTIwODE2ZmEwNjIyYjRmNWJhN2Y5ZGE0
-    MDRmODY2OWI4OTcyOTZlMzk5MjJlYzgxMzNmNzJmZmZkMzZiMWI=
+    ZGU4NGQwNGZiNjY1NGM0MzIyNzkwOTkwNWQ5OWVmNjQyNWU1MWU0Yzg5MWVk
+    NzI3YmZhZWEwNmUxMzNlOWVjM2E1Y2IyZWM2NDM3NDA3ZjVkNzI1ZDdiNjc1
+    MWQxNmQxYTQ0YWU1NmYwNzNhNDhhMTdiM2UxNzk5NmRkZjY5NzU=

data/bin/yarrow

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+begin
+  require "yarrow"
+rescue LoadError
+  require "rubygems"
+  require "yarrow"
+end

data/lib/yarrow/configuration.rb

@@ -0,0 +1,10 @@
+module Yarrow
+  class Configuration < Hashie::Mash
+   
+    def self.load(file)
+      configuration = self.new(YAML.load_file(file))
+      configuration
+    end
+    
+  end
+end

data/lib/yarrow/console_runner.rb

@@ -0,0 +1,200 @@
+module Yarrow
+  
+  class ConsoleRunner
+    
+    SUCCESS = 0
+    FAILURE = 1
+    
+    ENABLED_OPTIONS = {
+      :h => :help,
+      :v => :version,
+      :c => :config,
+      :t => :theme,
+    }
+    
+    ALLOWED_CONFIG_FILES = [
+      '.yarrowdoc',
+      'Yarrowdoc'
+    ]
+    
+    def initialize(arguments, io=STDOUT)
+      @out = io
+      @arguments = arguments
+      @options = {}
+      @targets = []
+      @config = Configuration.load(File.dirname(__FILE__) + "/defaults.yml")
+    end
+    
+    def config
+      @config
+    end
+    
+    def run_application
+      print_header
+      
+      begin
+        process_arguments
+      
+        if has_option?(:version)
+          return SUCCESS
+        end
+      
+        if has_option?(:help)
+          print_help
+          return SUCCESS
+        end
+        
+        process_configuration
+        
+        run_input_process
+        
+        run_output_process
+        
+        print_footer
+        
+        SUCCESS
+      rescue Exception => e
+        print_error e
+        FAILURE
+      end
+    end
+    
+    def process_arguments
+      @arguments.each do |arg|
+        if is_option?(arg)
+          register_option(arg)
+        else
+          @targets << arg
+        end
+      end
+    end
+    
+    # def load_configuration(path)
+    #   ALLOWED_CONFIG_FILES.each do |filename|
+    #     config_path = path + '/' + filename
+    #     if File.exists? config_path
+    #       @config.deep_merge! Configuration.load(config_path)
+    #       return
+    #     end
+    #   end
+    # end
+    
+    def process_configuration
+      #load_configuration(Dir.pwd)
+      
+      # @targets.each do |input_path|
+      #   @config.deep_merge! load_configuration(input_path)
+      # end
+      
+      if has_option?(:config)
+        path = @options[:config]
+        @config.deep_merge! Configuration.load(path)
+      end
+      
+      @config.options = @options.to_hash
+
+      #normalize_theme_path
+      
+      #theme = @config.options.theme
+      #@config.append load_configuration(theme)
+    end
+    
+    def normalize_theme_path
+      
+    end
+    
+    def register_option(raw_option)
+      option = raw_option.gsub(":", "=")
+      if option.include? "="
+        parts = option.split("=")
+        option = parts[0]
+        value = parts[1]
+      else
+        value = true
+      end
+      
+      name = option.gsub("-", "")
+      
+      if option[0..1] == "--"
+        if ENABLED_OPTIONS.has_value?(name.to_sym)
+          @options[name.to_sym] = value
+          return
+        end
+      else
+        if ENABLED_OPTIONS.has_key?(name.to_sym)
+          @options[ENABLED_OPTIONS[name.to_sym]] = value
+          return
+        end
+      end
+      
+      raise "Unrecognized option: #{raw_option}"
+    end
+    
+    def is_option?(argument)
+      argument[0] == "-"
+    end
+    
+    def has_option?(option)
+      @options.has_key? option
+    end
+    
+    def run_input_process
+      
+    end
+    
+    def run_output_process
+      
+    end
+    
+    def print_header
+      @out.puts Yarrow::APP_NAME + " " + Yarrow::VERSION
+    end
+    
+    def print_footer
+      @out.puts "Content generated at {path}!"
+    end
+    
+    def print_error(e)
+      @out.puts "Error! " + e.to_s
+    end
+    
+    def print_help
+      help = <<HELP
+  See http://yarrowdoc.org for more information.
+
+  Usage:
+
+   $ yarrow [options]
+   $ yarrow [options] <input>
+   $ yarrow [options] <input input> <output>
+
+   Arguments
+
+   <input>  -  Path to source directory or an individual source file. If not supplied
+               defaults to the current working directory. Multiple directories
+               can be specified by repeating arguments, separated by whitespace.
+
+   <output> -  Path to the generated documentation. If not supplied, defaults to
+               ./docs in the current working directory. If it does not exist, it
+               is created. If it does exist it remains in place, but existing
+               files are overwritten by new files with the same name.
+
+   Options
+
+   Use -o or --option for boolean switches and --option=value or --option:value
+   for options that require an explicit value to be set.
+
+    -h    --help          [switch]    Display this help message and exit
+    -v    --version       [switch]    Display version header and exit
+    -c    --config        [string]    Path to a config properties file
+    -p    --packages   	  [string]    Defines package convention for the model
+    -t    --theme         [string]    Template theme for generated docs
+
+
+HELP
+      @out.puts help
+    end
+
+  end
+
+end

data/lib/yarrow/defaults.yml

@@ -0,0 +1,5 @@
+# Default configuration settings for Yarrow.
+# This is loaded when the configuration is initialized.
+meta:
+  title: Default Project
+  author: Project Author

data/lib/yarrow/generator.rb

@@ -0,0 +1,12 @@
+module Yarrow
+
+  # Generates documentation from a model.
+  #
+  # Subclasses of Generator need to override the template methods,
+  # to specify a particular file structure to output.
+  class Generator
+  
+  
+  end
+
+end

data/lib/yarrow/version.rb

@@ -0,0 +1,4 @@
+module Yarrow
+  APP_NAME = "Yarrow"
+  VERSION = "0.1.2"
+end

data/lib/yarrow.rb

@@ -0,0 +1,7 @@
+require "hashie"
+require "yaml"
+
+require "yarrow/version"
+require "yarrow/configuration"
+require "yarrow/console_runner"
+require "yarrow/generator"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mark Rickerby
@@ -26,10 +26,18 @@ dependencies:
         version: '0'
 description: Documentation generator
 email: me@maetl.net
-executables: []
+executables:
+- yarrow
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- bin/yarrow
+- lib/yarrow/configuration.rb
+- lib/yarrow/console_runner.rb
+- lib/yarrow/defaults.yml
+- lib/yarrow/generator.rb
+- lib/yarrow/version.rb
+- lib/yarrow.rb
 homepage: http://rubygems.org/gems/yarrow
 licenses: []
 metadata: {}