gumdrop 0.5.1 → 0.5.2

data/ChangeLog.md

@@ -1,3 +1,9 @@
+# v0.5.2
+- DeferredLoader changed to DataManager
+- Added YamlDoc support to data collections -- a data format (.yamldoc) that strips YAML front matter and puts the content under the key 'content', or it will use a custom key from the front matter if the value of the pair is '_YAMLDOC_'
+- Templates are stored under their short name and full path now.
+- skip/ignore (blacklist and greylist) now use File.fnmatch instead of starts_with? for matching paths
+
 # v0.5.1
 - Bugfix: dev server was rescanning source files multiple times per pages load if build time exceeded 2 seconds... Will now wait 10 seconds before rescanning source.
 

data/Notes.md

@@ -1,15 +1,37 @@
 # Future Features/Changes
-- HTML Manifest generation??
 - Some kind of admin? What would that even do?
   - If you could specify a 'prototype' for data collections, could be cool.
 - Multiple source_dir?
   - `set :source_dir, ['./source/a', './source/b']
   - What would happen with conflicts, last one in wins?
 - Multiple data_dir too?
+- Refactor code to not use Gumdrop as a singleton (static really)
+- Add YamlDoc support for nodes?
+
 
 # TODO:
 - New/Update Doc Site
 - API for retrieving pages and pages under a path (simple query)
-- Cleanup api and verbiage around blacklisting and ignoring
-- YamlDoc support (in data anyway)
-- Templates should be stored as short name/path and full path (like partials)
+- Need test coverage.
+
+
+# Possible New Internals
+- Gumdrop (module)
+  - Site (class)
+    - SiteFileDSL (was DSL)
+    - Node (was Content)
+    - NodeGenerator (was Generator)
+  - Data (module)
+    - Manager (was DataManager)
+    - Collection
+    - Object
+    - Pager
+  - Server (module)
+    - NodeHandler
+    - ProxyHandler
+  - Render (module)
+    - Context
+    - ViewHelpers
+    - StitchCompilers
+  - Utils (module)
+    - Logging

data/lib/gumdrop/build.rb

@@ -36,6 +36,7 @@ module Gumdrop
 
           # Sort out Layouts, Generators, and Partials
           if File.extname(path) == ".template"
+            Gumdrop.layouts[path]= node
             Gumdrop.layouts[File.basename(path)]= node
 
           elsif File.extname(path) == ".generator"
@@ -62,10 +63,11 @@ module Gumdrop
       end
     end
 
+    # Expunge blacklisted files
     def filter_tree
-      Gumdrop.blacklist.each do |skip_path|
+      Gumdrop.blacklist.each do |blacklist_pattern|
         Gumdrop.site.keys.each do |source_path|
-          if source_path.starts_with? skip_path
+          if path_match source_path, blacklist_pattern
             Gumdrop.report "-excluding: #{source_path}", :info
             Gumdrop.site.delete source_path
           end
@@ -78,7 +80,7 @@ module Gumdrop
         output_base_path= File.expand_path(Gumdrop.config.output_dir)
         Gumdrop.report "[Compiling to #{output_base_path}]", :info
         Gumdrop.site.keys.sort.each do |path|
-          unless Gumdrop.greylist.any? {|p| path.starts_with?(p) }
+          unless Gumdrop.greylist.any? {|pattern| path_match path, pattern }
             node= Gumdrop.site[path]
             output_path= File.join(output_base_path, node.to_s)
             FileUtils.mkdir_p File.dirname(output_path)
@@ -98,6 +100,12 @@ module Gumdrop
       self
     end
 
+    # Match a path using a glob-like file pattern
+    def path_match(path, pattern)
+      File.fnmatch pattern, path, File::FNM_PATHNAME | File::FNM_DOTMATCH | File::FNM_CASEFOLD
+    end
+
+
     class << self
       def run(root, src, opts={})
         new(root, src, opts).run()

data/lib/gumdrop/context.rb

@@ -70,7 +70,7 @@ module Gumdrop
     
       def reset_data(preset={})
         # TODO: Add a setting for reloading data on every request/page
-        #@data= DeferredLoader.new if @data.nil? or !Gumdrop.config.cache_data
+        #  was this for the server?
         Gumdrop.data.reset if !Gumdrop.config.cache_data
         @state = preset
       end

data/lib/gumdrop/{deferred_loader.rb → data_manager.rb}

@@ -19,11 +19,10 @@ end
 
 module Gumdrop
   
-  class DeferredLoader
+  class DataManager
     attr_reader :cache
   
     def initialize(data_dir="data")
-      #puts "@!@"
       @dir= data_dir
       @cache= {}
       @persisted= {}
@@ -48,16 +47,22 @@ module Gumdrop
       end
     end
 
+    # TODO: This is not a great place for this. MOVE IT!
+    # This'll go on the Site class for query support: .find()/.all()/.paths()/.nodes()
     def site
-      # TODO: This is not a great place for this!
       site= Hash.new {|h,k| h[k]= nil }
       Gumdrop.site.keys.sort.each do |path|
-        unless Gumdrop.greylist.any? {|p| path.starts_with?(p) }
+        unless Gumdrop.greylist.any? {|pattern| path_match path, pattern }
           site[path]= Gumdrop.site[path]    
         end
       end
       site
     end
+    # Oh dear god! This belongs elsewhere!
+    def path_match(path, pattern)
+      File.fnmatch pattern, path, File::FNM_PATHNAME | File::FNM_DOTMATCH | File::FNM_CASEFOLD
+    end
+
 
     def site_all
       Gumdrop.site
@@ -87,27 +92,70 @@ module Gumdrop
       path=get_filename(key)
       return nil if path.nil?
       if File.extname(path) == ".yamldb"
-        docs=[]
-        File.open(path, 'r') do |f|
-          YAML.load_documents(f) do |doc|
-            docs << hashes2ostruct( doc ) unless doc.has_key?("__proto__")
-          end
-        end
-        docs
+        load_from_yamldb path
       elsif File.extname(path) == ""
-        all=[]
-        Dir[ File.join( "#{path}", "{*.yaml,*.json,*.yml}" ) ].each do |filename|
-          # Gumdrop.report ">> Loading data file: #{filename}"
-          id= File.basename filename
-          raw_hash= YAML.load_file(filename) 
-          raw_hash['_id']= id
-          obj_hash= hashes2ostruct( raw_hash )
-          all << obj_hash
+        load_from_directory path
+      else
+        load_from_file path
+      end
+    end
+
+    def load_from_file( filename )
+      ext=File.extname(filename)
+      if ext == '.yamldoc' or ext == '.ymldoc'
+        load_from_yamldoc filename
+      elsif ext == '.yaml' or ext == '.yml' or ext == '.json'
+        hashes2ostruct( YAML.load_file(filename)  )
+      else
+        raise "Unknown data type (#{ext}) for #{filename}"
+      end
+    end
+
+    def load_from_yamldb( filename )
+      docs=[]
+      File.open(filename, 'r') do |f|
+        YAML.load_documents(f) do |doc|
+          docs << hashes2ostruct( doc ) unless doc.has_key?("__proto__")
         end
-        all
+      end
+      docs
+    end
+
+    def load_from_yamldoc( filename )
+      source = File.read(filename)
+
+      if source =~ /^(\s*---(.+)---\s*)/m
+        yaml = $2.strip
+        content = source.sub($1, '')
+        data= YAML.load(yaml)
       else
-        hashes2ostruct( YAML.load_file(path)  )
+        content= source
+        data={}
+      end
+
+      content_set= false
+      data.each_pair do |key, value|
+        if value == '_YAMLDOC_'
+          data[key]= content
+          content_set= true
+        end
+      end
+
+      data['content']= content unless content_set
+      
+      hashes2ostruct(data)
+    end
+
+    def load_from_directory( filepath )
+      all=[]
+      Dir[ File.join( "#{filepath}", "{*.yaml,*.json,*.yml,*.yamldoc,*.ymldoc}" ) ].each do |filename|
+        # Gumdrop.report ">> Loading data file: #{filename}"
+        id= File.basename filename
+        obj_hash= load_from_file filename
+        obj_hash._id = id
+        all << obj_hash
       end
+      all
     end
 
     def get_filename(path)
@@ -133,4 +181,8 @@ module Gumdrop
       File.join(@dir.to_s, filename.to_s)
     end
   end
+
+  class YamlDoc
+
+  end
 end

data/lib/gumdrop/version.rb

@@ -1,5 +1,5 @@
 module Gumdrop
   
-  VERSION = "0.5.1" unless defined?(::Gumdrop::VERSION)
+  VERSION = "0.5.2" unless defined?(::Gumdrop::VERSION)
   
 end

data/lib/gumdrop.rb

@@ -29,7 +29,7 @@ module Gumdrop
   autoload :Build, "gumdrop/build"
   autoload :Context, "gumdrop/context"
   autoload :Content, "gumdrop/content"
-  autoload :DeferredLoader, "gumdrop/deferred_loader"
+  autoload :DataManager, "gumdrop/data_manager"
   autoload :DSL, "gumdrop/dsl"
   autoload :Generator, "gumdrop/generator"
   autoload :GeneratedrContent, "gumdrop/generator"
@@ -84,7 +84,7 @@ module Gumdrop
         @site        = Hash.new {|h,k| h[k]= nil }
         @layouts     = Hash.new {|h,k| h[k]= nil }
         @partials    = Hash.new {|h,k| h[k]= nil }
-        @data        = Gumdrop::DeferredLoader.new( Gumdrop.config.data_dir )
+        @data        = Gumdrop::DataManager.new( Gumdrop.config.data_dir )
         @last_run    = Time.now
 
         begin

data/templates/backbone/Gumdrop

@@ -27,9 +27,8 @@ end
 #  Ignores source file(s) from compilation, but does load the content into memory
 # ignore 'pages/'
 
-#  NOTE: Skipping and ignoring matches simply with starts_with?... So if a path, from the
-#  source directory, starts with the specified string, it'll skip or ignor it. (this
-#  doesn't work for files detected by stitch)
+#  NOTE: Skipping and ignoring matches like a file glob (it use File.fnmatch in fact)
+#       (this doesn't work for files detected by stitch)
 
 
 # Example site-level generator

data/templates/default/Gumdrop

@@ -21,14 +21,13 @@ end
 
 #  Skipping files entirely from build process... Like they don't exist.
 # skip 'file-to-ignore.html'
-# skip 'dont-show/'
+# skip 'dont-show/**/*'
 
 #  Ignores source file(s) from compilation, but does load the content into memory
-# ignore 'pages/'
+# ignore 'pages/**/*.*'
 
-#  NOTE: Skipping and ignoring matches simply with starts_with?... So if a path, from the
-#  source directory, starts with the specified string, it'll skip or ignor it. (this
-#  doesn't work for files detected by stitch)
+#  NOTE: Skipping and ignoring matches like a file glob (it use File.fnmatch in fact)
+#       (this doesn't work for files detected by stitch)
 
 
 # Example site-level generator

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gumdrop
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-07-22 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70144022144960 !ruby/object:Gem::Requirement
+  requirement: &70136900293340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70144022144960
+  version_requirements: *70136900293340
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70144022143820 !ruby/object:Gem::Requirement
+  requirement: &70136900292760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70144022143820
+  version_requirements: *70136900292760
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &70144022142220 !ruby/object:Gem::Requirement
+  requirement: &70136900292200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70144022142220
+  version_requirements: *70136900292200
 - !ruby/object:Gem::Dependency
   name: trollop
-  requirement: &70144022140860 !ruby/object:Gem::Requirement
+  requirement: &70136900291500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70144022140860
+  version_requirements: *70136900291500
 - !ruby/object:Gem::Dependency
   name: haml
-  requirement: &70144022139160 !ruby/object:Gem::Requirement
+  requirement: &70136900291040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70144022139160
+  version_requirements: *70136900291040
 - !ruby/object:Gem::Dependency
   name: sass
-  requirement: &70144022138500 !ruby/object:Gem::Requirement
+  requirement: &70136900290620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70144022138500
+  version_requirements: *70136900290620
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70144022137500 !ruby/object:Gem::Requirement
+  requirement: &70136900290080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70144022137500
+  version_requirements: *70136900290080
 - !ruby/object:Gem::Dependency
   name: bundle
-  requirement: &70144022136600 !ruby/object:Gem::Requirement
+  requirement: &70136900289660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70144022136600
+  version_requirements: *70136900289660
 description: A simple cms/prototyping tool.
 email: matt@elucidata.net
 executables:
@@ -120,7 +120,7 @@ files:
 - lib/gumdrop/cli.rb
 - lib/gumdrop/content.rb
 - lib/gumdrop/context.rb
-- lib/gumdrop/deferred_loader.rb
+- lib/gumdrop/data_manager.rb
 - lib/gumdrop/dsl.rb
 - lib/gumdrop/generator.rb
 - lib/gumdrop/hash_object.rb