yarrow 0.2.5 → 0.2.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODNiM2E2NjAzNzkwOTVmMDkyZGQzYjFmODg1YzFlZjRmZmYyMDZlZg==
+    ZjViODEzNDFmNDI5OTgwNjNkODY1YWExMDE4ZTM4YWYzNDQ3ZDJiOA==
   data.tar.gz: !binary |-
-    ZTJhMDE4M2EzODBhNjUwODRkYjVkYzBhMzNmZDhiMzhiZmU4NmJiYg==
+    ODYwNjY4Y2QxMDYzZjdjZDEwOWMzOWY1ZjdhZGU0ZDBjZThlOWNhMg==
 SHA512:
   metadata.gz: !binary |-
-    MzVmOTRhYzVlZjIyMzkzMzhmYzEzOGFjN2Y3MmEzZGJkNGZlZDZkYmNiMTkw
-    NjQyZDJkZjI4NGI5ZjYyODYzMjA5ZGJmZjI3N2M2MzA4ODVmODhlYmNlZjlk
-    ZTk0MzYzZTQ3MzUwOWJlNjdiYTJhYWY2YjkzNzY1M2E5NTA0ZGU=
+    OGI4OWIxZTNjMDc1NWM4NGVlMGIwNGJiYzQwZWI3YTNhOTYxMWY0YWFjMjQy
+    MTlmODlhYmU3YTA5ZjJkNWQ3NTdjYjYzYmI3ZTNjMDc1ZjU3NDA3MDQ5NjY4
+    MzBmZmJlZTNmOTk4N2NmMzE1YjZkMDA4NDQyNDM2YmUxZTU5YzQ=
   data.tar.gz: !binary |-
-    MDg4MDkyNzhlMzE1OTc0ZDIzNzc2Y2ZlNWFjN2U1NzJkNTc1N2U1OTg2ZmFl
-    MDRkZGE2MWZlOWNjMWI4Y2VhODU1MDdiMDcyMDc3OTAyZjI0MTZjMWMyM2Yz
-    Yjk5ZWM0Y2I5MjUzN2I5MWQ2MmNmZDg3ZDI5MTc4MTNlNWFiNzk=
+    NTRhZWNjNzcyNjcyM2M4YzkyZmQyNjMxYmMwNDVkMGVlNzYwYzcxMTVkOGYw
+    ZDBiOWY1Mjg4NzNiMjJkMTM2MWE0YzRiYzI4NDIzMzkyMDEzMzJkZGE4YWZl
+    NjEwNGYxN2RhMTQyM2UxZWU5ZTI3NjVkMzA2ODVlYTRlNzA5OGE=

data/lib/yarrow/assets/manifest.rb

@@ -0,0 +1,55 @@
+# TODO: where else is this used?
+require 'json'
+
+module Yarrow
+  module Assets
+
+    ##
+    # Provides access to the bundle of compiled CSS and JS assets.
+    #
+    class Manifest
+
+      def initialize(config)
+        if config[:output_dir] && config[:manifest_path]
+          manifest_path = [config[:output_dir], config[:manifest_path]].join('/')
+        else
+          manifest_path = './manifest.json'
+        end
+
+        if File.exists?(manifest_path)
+          @manifest_index = JSON.parse(File.read(manifest_path))
+        else
+          @manifest_index = {
+            'assets' => {},
+            'files' => {}
+          }
+        end
+      end
+
+      def exists?(logical_path)
+      	@manifest_index['assets'].key? logical_path
+      end
+
+      def digest_path(logical_path)
+      	@manifest_index['assets'][logical_path]
+      end
+
+      def file(logical_path)
+      	@manifest_index['files'][digest_path(logical_path)]
+      end
+
+      def logical_paths
+      	@manifest_index['assets'].keys
+      end
+
+      def digest_paths
+      	@manifest_index['files'].keys
+      end
+
+      def files
+      	@manifest_index['files'].values
+      end
+
+    end
+  end
+end

data/lib/yarrow/assets.rb

@@ -1 +1,2 @@
-require_relative "assets/pipeline"
+require_relative 'assets/pipeline'
+require_relative 'assets/manifest'

data/lib/yarrow/configuration.rb

@@ -1,9 +1,21 @@
 module Yarrow
   class Configuration < Hashie::Mash
    
-    def self.load(file)
-      configuration = self.new(YAML.load_file(file))
-      configuration
+    class << self
+
+      def instance
+        @@configuration || Hashie::Mash.new
+      end
+
+      def register(file)
+        @@configuration = self.load(file)
+      end
+
+      def load(file)
+        configuration = self.new(YAML.load_file(file))
+        configuration
+      end
+
     end
     
   end

data/lib/yarrow/defaults.yml

@@ -2,4 +2,7 @@
 # This is loaded when the configuration is initialized.
 meta:
   title: Default Project
-  author: Project Author
+  author: Project Author
+output:
+  object_map:
+    page: Yarrow::Model::Site.pages

data/lib/yarrow/html/asset_tags.rb

@@ -0,0 +1,40 @@
+module Yarrow
+  module HTML
+    module AssetTags
+      
+      # TODO: make sprockets manifest optional/pluggable
+      def manifest
+        Yarrow::Assets::Manifest.new(config || {})
+      end
+
+      def all_script_tags
+        out = []
+        manifest.digest_paths.each do |asset|
+          out << script_tag(:asset => asset)
+        end
+        out.join["\n"]
+      end
+
+      def script_tag(options)
+        if options.has_key? :asset and manifest.exists?(options[:asset])
+          src_path = manifest.digest_path(options[:asset])
+        else
+          src_path = options[:src]
+        end
+
+        "<script src=\"#{src_path}\"></script>"
+      end
+
+      def link_tag(options)
+        if options.has_key? :asset and manifest.exists?(options[:asset])
+          href_path = manifest.digest_path(options[:asset])
+        else
+          href_path = options[:href]
+        end
+
+        "<link href=\"#{href_path}\" rel=\"stylesheet\" type=\"text/css\">"
+      end
+
+    end
+  end
+end

data/lib/yarrow/html/content_tags.rb

@@ -0,0 +1,7 @@
+module Yarrow
+  module HTML
+    module ContentTags
+      
+    end
+  end
+end

data/lib/yarrow/html.rb

@@ -0,0 +1 @@
+require_relative 'html/asset_tags'

data/lib/yarrow/model/base.rb

@@ -0,0 +1,13 @@
+require "mementus"
+require "active_support/inflector"
+
+module Yarrow
+  module Model
+    class Base < Mementus::Model
+      def self.inherited(klass)
+        self.superclass.inherited(klass)
+        Index.register(klass)
+      end
+    end
+  end
+end

data/lib/yarrow/model/index.rb

@@ -0,0 +1,13 @@
+require "active_support/inflector"
+
+module Yarrow
+  module Model
+    class Index
+      def self.register(klass)
+        method_name = ActiveSupport::Inflector.pluralize(ActiveSupport::Inflector.underscore(klass.to_s)).to_sym
+        puts method_name
+        define_singleton_method method_name, lambda { klass.all }
+      end
+    end
+  end
+end

data/lib/yarrow/output/context.rb

@@ -0,0 +1,24 @@
+module Yarrow
+  module Output
+
+    ##
+    # Provides a data context for rendering a template.
+    #
+    # Methods provided by this class become available as named variables in Mustache templates.
+    # 
+    # Includes the library of helpers for dynamically generating HTML tags.
+    #
+    class Context
+
+      include Yarrow::HTML::AssetTags
+
+      def initialize(attributes)
+        metaclass = class << self; self; end
+        attributes.each do |name, value|
+          metaclass.send :define_method, name, lambda { value }
+        end
+      end
+    end
+
+  end
+end

data/lib/yarrow/output/generator.rb

@@ -0,0 +1,43 @@
+module Yarrow
+  module Output
+    # Generates documentation from an object model.
+    class Generator
+      def initialize(config={})
+        @config = config
+      end
+
+      # Mapping between template types and provided object model
+      def object_map
+        @config.output.object_map
+      end
+
+      # Mapping between template types and provided output templates.
+      def template_map
+        
+      end
+
+      # Template converter used by this generator instance.
+      def converter
+
+      end
+
+      def write_output_file(filename, content)
+      end
+
+      # Builds the output documentation.
+      def build_docs
+        object_map.each do |index, objects|
+          objects.each do |object|
+            template_context = {
+              #:meta => Site
+              index => object
+            }
+            content = converter.render(template_map[index], template_context)
+            filename = converter.filename_for(object)
+            write_output_file(filename, content)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yarrow/output/mapper.rb

@@ -0,0 +1,23 @@
+module Yarrow
+  module Output
+    class Mapper
+
+      def initialize(config)
+        @config = config
+      end
+
+      def object_map
+        @config.output.object_map
+      end
+
+      def template_map
+        @config.output.template_map
+      end
+
+      def model
+
+      end
+
+    end
+  end
+end

data/lib/yarrow/tools/front_matter.rb

@@ -3,7 +3,7 @@ module Yarrow
     module FrontMatter
 
       def read_split_content(path)
-        extract_split_content(File.read(path))
+        extract_split_content(File.read(path, :encoding => 'utf-8'))
       end
 
       def extract_split_content(text)

data/lib/yarrow/version.rb

@@ -1,4 +1,4 @@
 module Yarrow
   APP_NAME = "Yarrow"
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/lib/yarrow.rb

@@ -6,8 +6,13 @@ require_relative "yarrow/logging"
 require_relative "yarrow/configuration"
 require_relative "yarrow/console_runner"
 require_relative "yarrow/generator"
+require_relative "yarrow/model/index"
+require_relative "yarrow/model/base"
+require_relative "yarrow/output/mapper"
+require_relative "yarrow/output/generator"
 require_relative "yarrow/content_map"
 require_relative "yarrow/assets"
+require_relative "yarrow/html"
 require_relative "yarrow/tools/front_matter"
 
 # Dir[File.dirname(__FILE__) + "/yarrow/generators/*.rb"].each do |generator|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yarrow
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Mark Rickerby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-04 00:00:00.000000000 Z
+date: 2014-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -52,6 +52,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: Yarrow is a tool for generating well structured documentation from a
-  variety of input sourcespec.
+  variety of input sources.
 email: me@maetl.net
 executables:
 - yarrow
@@ -103,6 +117,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/yarrow
+- lib/yarrow/assets/manifest.rb
 - lib/yarrow/assets/pipeline.rb
 - lib/yarrow/assets.rb
 - lib/yarrow/configuration.rb
@@ -110,7 +125,15 @@ files:
 - lib/yarrow/content_map.rb
 - lib/yarrow/defaults.yml
 - lib/yarrow/generator.rb
+- lib/yarrow/html/asset_tags.rb
+- lib/yarrow/html/content_tags.rb
+- lib/yarrow/html.rb
 - lib/yarrow/logging.rb
+- lib/yarrow/model/base.rb
+- lib/yarrow/model/index.rb
+- lib/yarrow/output/context.rb
+- lib/yarrow/output/generator.rb
+- lib/yarrow/output/mapper.rb
 - lib/yarrow/tools/front_matter.rb
 - lib/yarrow/version.rb
 - lib/yarrow.rb