ruhoh 2.5 → 2.6

data/lib/ruhoh/resources/theme/compiler.rb

@@ -8,7 +8,7 @@ module Ruhoh::Resources::Theme
       return unless setup_compilable
 
       self.files.each do |file|
-        original_file = File.join(@ruhoh.paths.theme, file)
+        original_file = File.join(@ruhoh.cascade.theme, file)
         compiled_file = File.join(@collection.compiled_path, file)
         FileUtils.mkdir_p File.dirname(compiled_file)
         FileUtils.cp_r original_file, compiled_file
@@ -19,7 +19,7 @@ module Ruhoh::Resources::Theme
     # Returns list of all files from the theme to be compiled.
     # @returns[Array] relative filepaths
     def files
-      FileUtils.cd(@ruhoh.paths.theme) {
+      FileUtils.cd(@ruhoh.cascade.theme) {
         return Dir["**/*"].select { |filepath|
           is_valid_asset?(filepath)
         }

data/lib/ruhoh/resources/widgets/collection.rb

@@ -4,8 +4,8 @@ module Ruhoh::Resources::Widgets
 
     def initialize(ruhoh)
       @ruhoh = ruhoh
-      @path = File.join(@ruhoh.paths.base, "widgets")
-      @system_path = File.join(@ruhoh.paths.system, "widgets")
+      @path = File.join(@ruhoh.cascade.base, "widgets")
+      @system_path = File.join(@ruhoh.cascade.system, "widgets")
     end
 
     def url_endpoint

data/lib/ruhoh/routes.rb

@@ -28,7 +28,7 @@ class Ruhoh
 
     def routable
        @ruhoh.collections.all.keep_if do |r|
-          @ruhoh.collections.collection(r).include?(Ruhoh::Resources::Pages::Routable) rescue false
+          @ruhoh.collections.collection(r).include?(Ruhoh::Base::Routable) rescue false
         end
     end
   end

data/lib/ruhoh/summarizer.rb

@@ -23,7 +23,7 @@ class Ruhoh
 
       # Return a summary element if specified
       summary_el = content_doc.at_css('.' + SummaryNodeClassName)
-      return summary_el.to_html if summary_el
+      return summary_el.to_html(:encoding => 'UTF-8') if summary_el
 
       # Create the summary element.
       summary_doc = Nokogiri::XML::Node.new("div", Nokogiri::HTML::Document.new)
@@ -59,7 +59,7 @@ class Ruhoh
         summary_doc << node
       end
 
-      summary_doc.to_html
+      summary_doc.to_html(:encoding => 'UTF-8')
     end
   end
 end

data/lib/ruhoh/ui/dashboard.rb

@@ -0,0 +1,13 @@
+class Ruhoh::UI::Dashboard
+  def initialize(ruhoh)
+    @ruhoh = ruhoh
+  end
+
+  def call(env)
+    path = @ruhoh.cascade.find_file('dashboard')['realpath']
+    template = File.open(path, 'r:UTF-8').read
+    view = @ruhoh.master_view({"content" => template })
+
+    [200, {'Content-Type' => 'text/html'}, [ view.content ]]
+  end
+end

data/lib/ruhoh/ui/page_not_found.rb

@@ -25,11 +25,12 @@ TEXT
     end
 
     def show
-      template = File.open(File.join(File.dirname(__FILE__), 'page_not_found.html'), 'r:UTF-8').read
+      path = @ruhoh.cascade.find_file('page_not_found')['realpath']
+      template = File.open(path, 'r:UTF-8').read
       body = Mustache.render(template, {
         pointer: @pointer,
         url: @request.path,
-        filepath: File.join(File.basename(@ruhoh.base), filepath),
+        filepath: File.join(File.basename(@ruhoh.cascade.base), filepath),
         content: Content
       })
 

data/lib/ruhoh/url_slug.rb

@@ -20,15 +20,33 @@ class Ruhoh
 
     # @return[String] the dynamic URL with token substitution.
     def dynamic
-      data.inject(@format) { |result, token|
-        result.gsub(/:#{ Regexp.escape(token.first) }/, token.last)
-      }.gsub(/\/+/, "/")
+      cache = data
+      result = @format
+                .gsub(/:[^\/\.]+/) { |a| cache[$&.gsub(':', '')] }
+                .gsub('//', '/')
+                .split('/')
+
+      # this is ugly but I'm out of ideas. Help!
+      last = result.pop
+      if uses_extension?
+        last = last
+                .split('.')
+                .map{ |a| Ruhoh::StringFormat.clean_slug_and_escape(a) }
+                .join('.')
+      else
+        last = Ruhoh::StringFormat.clean_slug_and_escape(last)
+      end
+
+      result
+        .map{ |a| Ruhoh::StringFormat.clean_slug_and_escape(a) }
+        .join('/') + "/#{ last }"
     end
 
     def data
-      result = uses_date? ? date_data : {}
+      result = @page_data
+      result = result.merge(date_data) if uses_date?
+
       result.merge({
-        "title"             => title,
         "filename"          => filename,
         "path"              => path,
         "relative_path"     => relative_path,
@@ -55,10 +73,6 @@ class Ruhoh
       )
     end
 
-    def title
-      Ruhoh::StringFormat.clean_slug_and_escape(@page_data['title'])
-    end
-
     def filename
       File.basename(@page_data['id'], ext)
     end

data/lib/ruhoh/version.rb

@@ -1,4 +1,4 @@
 class Ruhoh
-  Version = VERSION = '2.5'
+  Version = VERSION = '2.6'
   RuhohSpec = '2.1'
 end

data/lib/ruhoh/views/master_view.rb

@@ -51,7 +51,7 @@ module Ruhoh::Views
 
     def urls
       @ruhoh.collections.url_endpoints.merge({
-        'base_path' => @ruhoh.base_path,
+        'base_path' => @ruhoh.config.base_path,
         'production' => @ruhoh.config["production_url"],
         'production_url' => @ruhoh.config["production_url"]
       })

data/spec/lib/ruhoh/plugins/initializer_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+module Ruhoh::Plugins
+  describe Initializer do
+    describe 'constructor' do
+      it 'raises an error when block is not defined' do
+        expect { Initializer.new 'foo' }.to raise_error ArgumentError
+        expect { Initializer.new('foo') { } }.to_not raise_error
+      end
+    end
+
+    describe '#run' do
+      it "raises an error when it's not bound" do
+        initializer = Initializer.new('foo') { }
+        expect { initializer.run }.to raise_error RuntimeError
+        expect { initializer.bind(self).run }.to_not raise_error
+      end
+
+      it 'executes the block in the bound context' do
+        initializer = Initializer.new('foo') do
+          self << 'a' if length == 1
+        end
+        obj = ['b']
+        expect { initializer.bind(obj).run }.to change(obj, :length).to 2
+      end
+
+      it 'passes given arguments to block' do
+        initializer = Initializer.new('foo') do |arg|
+          raise 'arg is absent' if arg != 'a'
+        end
+        expect { initializer.bind(self).run }.to raise_error 'arg is absent'
+        expect { initializer.run 'a' }.to_not raise_error
+      end
+    end
+
+    describe '#bind' do
+      it 'returns self' do
+        initializer = Initializer.new('foo') { }
+        initializer.bind(self).should == initializer
+      end
+    end
+  end
+end

data/spec/lib/ruhoh/plugins/plugin_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+module Ruhoh::Plugins
+  describe Plugin do
+    describe '::initializers' do
+      it 'returns an array' do
+        Plugin.initializers.should be_a Array
+      end
+
+      it 'memoizes the array' do
+        Plugin.initializers.object_id.should == Plugin.initializers.object_id
+      end
+    end
+
+    context 'when included in a class' do
+      let(:instance_class) do
+        Class.new do
+          include Plugin
+        end
+      end
+
+      it 'defines the ::initializer method' do
+        instance_class.should respond_to :initializer
+      end
+
+      describe '::initializer' do
+        it 'appends to initializers collection' do
+          expect {
+            instance_class.initializer('foo') { }
+          }.to change(Plugin.initializers, :length).to 1
+        end
+
+        it 'appends an initializer object filled with given params' do
+          instance_class.initializer('foo') { }
+          Plugin.initializers.first.name.should == 'foo'
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.expand_path '../../lib/ruhoh', __FILE__

data/system/config.json

@@ -0,0 +1,21 @@
+{
+    "base_path" : "/"
+    ,
+    "date_format" : "%Y-%m-%d"
+    ,
+    "compiled_path" : "compiled"
+    ,
+    "compiled" : {
+        "use" : "ignore"
+    }
+    ,
+    "_root" : {
+        "permalink" : "/:relative_path/:filename",
+        "paginator" : {
+            "url" : "/index/"
+        },
+        "rss" : {
+            "url" : "/"
+        }
+    }
+}

data/system/{dash/index.html → dashboard.html}

@@ -209,4 +209,4 @@
     Tabs.init();
   </script>
 </body>
-</html>
+</html>

data/system/plugins/sprockets/compiler.rb

@@ -5,6 +5,7 @@ module Ruhoh::SprocketsPlugin
     extend Ruhoh::Base::CompilableAsset
     def run
       env = Sprockets::Environment.new
+      #env.css_compressor = :sass
       env.logger = Logger.new(STDOUT)
       env.logger.level = Logger::WARN
 

data/system/widgets/comments/disqus.html

@@ -9,7 +9,7 @@ short_name : jekyllbootstrap # Change This!
     /* * * DON'T EDIT BELOW THIS LINE * * */
     (function() {
         var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
-        dsq.src = 'http://' + disqus_shortname + '.disqus.com/embed.js';
+        dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
         (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
     })();
 </script>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruhoh
 version: !ruby/object:Gem::Version
-  version: '2.5'
+  version: '2.6'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-22 00:00:00.000000000 Z
+date: 2013-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -151,6 +151,7 @@ files:
 - Rakefile
 - bin/ruhoh
 - cucumber.yml
+- features/_root.feature
 - features/base_path.feature
 - features/categories.feature
 - features/config.feature
@@ -165,6 +166,8 @@ files:
 - features/pagination.feature
 - features/partials.feature
 - features/permalinks.feature
+- features/plugins.feature
+- features/sort_order.feature
 - features/static.feature
 - features/step_defs.rb
 - features/stylesheets.feature
@@ -178,34 +181,45 @@ files:
 - features/widgets/widgets.feature
 - history.json
 - lib/ruhoh.rb
-- lib/ruhoh/base/collection.rb
-- lib/ruhoh/base/compiler.rb
-- lib/ruhoh/base/model.rb
-- lib/ruhoh/base/model_view.rb
-- lib/ruhoh/base/watcher.rb
+- lib/ruhoh/base/collectable.rb
+- lib/ruhoh/base/compilable.rb
+- lib/ruhoh/base/compilable_asset.rb
+- lib/ruhoh/base/model_viewable.rb
+- lib/ruhoh/base/modelable.rb
+- lib/ruhoh/base/page_like.rb
+- lib/ruhoh/base/page_viewable.rb
+- lib/ruhoh/base/routable.rb
+- lib/ruhoh/base/watchable.rb
 - lib/ruhoh/cache.rb
+- lib/ruhoh/cascade.rb
 - lib/ruhoh/client.rb
 - lib/ruhoh/collections.rb
+- lib/ruhoh/config.rb
 - lib/ruhoh/console_methods.rb
 - lib/ruhoh/converter.rb
 - lib/ruhoh/converters/markdown.rb
 - lib/ruhoh/friend.rb
 - lib/ruhoh/logger.rb
 - lib/ruhoh/parse.rb
+- lib/ruhoh/plugins/initializer.rb
+- lib/ruhoh/plugins/local_plugins_plugin.rb
+- lib/ruhoh/plugins/plugin.rb
 - lib/ruhoh/programs/compile.rb
 - lib/ruhoh/programs/preview.rb
 - lib/ruhoh/programs/watch.rb
 - lib/ruhoh/publish/rsync.rb
-- lib/ruhoh/resources/dash/collection.rb
-- lib/ruhoh/resources/dash/model.rb
-- lib/ruhoh/resources/dash/model_view.rb
-- lib/ruhoh/resources/dash/previewer.rb
+- lib/ruhoh/resources/_base/collection.rb
+- lib/ruhoh/resources/_base/compiler.rb
+- lib/ruhoh/resources/_base/model.rb
+- lib/ruhoh/resources/_base/model_view.rb
+- lib/ruhoh/resources/_base/watcher.rb
 - lib/ruhoh/resources/data/collection.rb
 - lib/ruhoh/resources/data/collection_view.rb
 - lib/ruhoh/resources/ignore/collection.rb
 - lib/ruhoh/resources/javascripts/collection.rb
 - lib/ruhoh/resources/javascripts/collection_view.rb
 - lib/ruhoh/resources/javascripts/compiler.rb
+- lib/ruhoh/resources/javascripts/model_view.rb
 - lib/ruhoh/resources/layouts/client.rb
 - lib/ruhoh/resources/layouts/model.rb
 - lib/ruhoh/resources/media/collection.rb
@@ -233,7 +247,7 @@ files:
 - lib/ruhoh/string_format.rb
 - lib/ruhoh/summarizer.rb
 - lib/ruhoh/time.rb
-- lib/ruhoh/ui/page_not_found.html
+- lib/ruhoh/ui/dashboard.rb
 - lib/ruhoh/ui/page_not_found.rb
 - lib/ruhoh/url_slug.rb
 - lib/ruhoh/utils.rb
@@ -245,10 +259,15 @@ files:
 - lib/ruhoh/views/master_view.rb
 - lib/ruhoh/views/rmustache.rb
 - ruhoh.gemspec
+- spec/lib/ruhoh/plugins/initializer_spec.rb
+- spec/lib/ruhoh/plugins/plugin_spec.rb
+- spec/spec_helper.rb
 - system/_scaffold.html
-- system/dash/index.html
+- system/config.json
+- system/dashboard.html
 - system/layouts/_scaffold.html
 - system/layouts/paginator.html
+- system/page_not_found.html
 - system/partials/categories_list.html
 - system/partials/pages_list.html
 - system/partials/posts_collate.html
@@ -285,7 +304,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4393455842480950745
+      hash: -1883264674327180773
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -294,7 +313,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4393455842480950745
+      hash: -1883264674327180773
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/lib/ruhoh/base/collection.rb

@@ -1,284 +0,0 @@
-module Ruhoh::Base
-
-  module Collectable
-
-    def self.included(klass)
-      klass.__send__(:attr_accessor, :resource_name, :master)
-      klass.__send__(:attr_reader, :ruhoh)
-    end
-
-    def initialize(ruhoh)
-      @ruhoh = ruhoh
-    end
-
-    # Public API for finding a resource from this collection
-    # @param name_or_pointer [String, Hash]
-    #  Hash   - File pointer
-    #  String - id (filename) with full extension, e.g: about-me.md
-    #  String - name (filename) without the extension e.g: about-me
-    #           Returns the first matched filename.
-    #           See implementation for how match is determined.
-    # @param opts [Hash] Optional options
-    #  opts[:all] - true to search all files as some may be invalid as resources
-    #
-    # @return[model, nil] the model is always wrapped in its view.
-    def find(name_or_pointer, opts={})
-      pointer = find_file(name_or_pointer, opts)
-      return nil unless pointer
-
-      @ruhoh.cache.get(pointer['realpath']) ||
-      @ruhoh.cache.set(pointer['realpath'], load_model_view(pointer))
-    end
-
-    # Public API
-    # @return[Hash] dictionary of models { "id" => Model }
-    def dictionary
-      dict = {}
-      files.values.each { |pointer|
-        dict.merge!({
-          pointer['id'] => find(pointer)
-        })
-      }
-      dict
-    end
-
-    def resource_name
-      @resource_name ||= self.class.name.split("::").pop
-    end
-
-    # Implemented via Observable module
-    # See http://ruby-doc.org/stdlib-1.9.3/libdoc/observer/rdoc/Observable.html
-    # Collection subscribes to its child models.
-    # #update is called on model #process.
-    # noop
-    def update(model_data)
-    end
-
-    # The default glob for finding files.
-    # Every file in all child directories.
-    def glob
-      "**/*"
-    end
-
-    # Default paths to the 3 levels of the cascade.
-    def paths
-      Array(@ruhoh.cascade.map{|h| h["path"]}).map { |path|
-        collection_path = File.join(path, resource_name)
-        next unless File.directory?(collection_path)
-
-        collection_path
-      }.compact
-    end
-
-    # Does this resource have any valid paths to process?
-    # A valid path may exist on any of the cascade levels.
-    # False means there are no directories on any cascade level.
-    # @returns[Boolean]
-    def paths?
-      !paths.empty?
-    end
-
-    def config
-      config = @ruhoh.config[resource_name] || {}
-      unless config.is_a?(Hash)
-        Ruhoh.log.error("'#{resource_name}' config key in config" +
-                        " is a #{config.class}; it needs to be a Hash (object).")
-      end
-      config
-    end
-
-    # NOOP
-    # touch a model.
-    # Used to perform custom regeneration logic against a model.
-    def touch(name_or_pointer)
-    end
-
-    # @param key [String, Hash]
-    #  String - id (filename) with full extension, e.g: about-me.md
-    #  String - name (filename) without the extension e.g: about-me
-    #           Returns the first matched filename.
-    #           See implementation for how match is determined.
-    #  Hash   - File pointer
-    #
-    # @param opts [Hash] Optional options
-    #  opts[:all] - true to search all files as some may be invalid as resources
-    #
-    # @return [pointer, nil]
-    def find_file(key, opts={})
-      return key if key.is_a?(Hash) # assume valid pointer
-
-      dict = opts[:all] ? _all_files : files
-
-      dict[key] || dict.values.find{ |a| key == a['id'].gsub(/.[^.]+$/, '') }
-    end
-
-    # Collect all files (as mapped by data resources) for this data endpoint.
-    # Each resource can have 3 file references, one per each cascade level.
-    # The file hashes are collected in order 
-    # so they will overwrite eachother if found.
-
-    # @param id [String, Array] Optional.
-    #   Collect all files for a single data resource.
-    #   Can be many files due to the cascade.
-    # @param [block] Optional.
-    #   Implement custom validation logic by passing in a block.
-    #   The block is given (id, self) as args.
-    #   Return true/false for whether the file is valid/invalid.
-    #
-    # @return[Hash] dictionary of pointers.
-    def files(id=nil, &block)
-      return @ruhoh.cache.get(files_cache_key) if @ruhoh.cache.get(files_cache_key)
-
-      dict = _all_files
-      dict.keep_if do |id, pointer|
-        block_given? ? yield(id, self) : valid_file?(id)
-      end
-
-      @ruhoh.cache.set(files_cache_key, dict)
-      dict
-    end
-
-    # Collect all files within this collection, valid or otherwise.
-    # Each resource can have 3 file references, one per each cascade level.
-    # The file hashes are collected in order and overwrite eachother if found.
-    # This is a low-level method, see #files for the public interface.
-    #
-    # @return[Hash] dictionary of pointers.
-    def _all_files
-      dict = {}
-      paths.each do |path|
-        FileUtils.cd(path) { 
-          Dir[glob].each { |id|
-            next unless File.exist?(id) && FileTest.file?(id)
-            dict[id] = {
-              "id" => id,
-              "realpath" => File.realpath(id),
-              "resource" => resource_name,
-            }
-          }
-        }
-      end
-
-      dict
-    end
-
-    def valid_file?(filepath)
-      return false if filepath.start_with?('.')
-      return false if filepath.start_with?('_')
-      excludes = Array(config['exclude']).map { |node| Regexp.new(node) }
-      excludes.each { |regex| return false if filepath =~ regex }
-      true
-    end
-
-    %w{
-      collection_view
-      model
-      model_view
-      client
-      compiler
-      watcher
-      previewer
-    }.each do |method_name|
-      define_method(method_name) do
-        get_module_namespace.const_get(camelize(method_name).to_sym)
-      end
-
-      define_method("#{method_name}?") do
-        get_module_namespace.const_defined?(camelize(method_name).to_sym)
-      end
-    end
-
-    def load_collection_view
-      @_collection_view ||= collection_view? ?
-                              collection_view.new(self) :
-                              self
-    end
-
-    def load_model(pointer)
-      _model = model? ?
-                model.new(@ruhoh, pointer) :
-                Ruhoh::Base::Model.new(@ruhoh, pointer)
-      _model.add_observer(self)
-      _model
-    end
-
-    def load_model_view(pointer)
-      model_view? ? 
-        model_view.new(load_model(pointer)) :
-        Ruhoh::Base::ModelView.new(load_model(pointer))
-    end
-
-    def load_client(opts)
-      @_client ||= client.new(load_collection_view, opts)
-    end
-
-    def load_compiler
-      @_compiler ||= compiler.new(load_collection_view)
-    end
-
-    def load_watcher(*args)
-      @_watcher ||= watcher? ?
-        watcher.new(load_collection_view) :
-        Ruhoh::Base::Watcher.new(load_collection_view)
-    end
-
-    def load_previewer(*args)
-      @_previewer ||= previewer.new(@ruhoh)
-    end
-
-    def files_cache_key
-      "#{ resource_name }-files"
-    end
-
-    def scaffold
-      pointer = find_file('_scaffold', all: true) || @ruhoh.find_file('_scaffold')
-      return '' unless pointer
-
-      File.open(pointer['realpath'], 'r:UTF-8') { |f| f.read }
-    end
-
-    def compiled_path
-      @compiled_path ||= @ruhoh.compiled_path(@ruhoh.to_url(url_endpoint))
-    end
-
-    protected
-
-    # Load the registered resource else default to Pages if not configured.
-    # @returns[Constant] the resource's module namespace
-    def get_module_namespace
-      type = @ruhoh.config[resource_name]["use"] rescue nil
-      if type
-        if @ruhoh.collections.registered.include?(type)
-          Ruhoh::Resources.const_get(camelize(type))
-        elsif @ruhoh.collections.base.include?(type)
-          Ruhoh::Base.const_get(camelize(type))
-        else
-          klass = camelize(type)
-          Friend.say {
-            red "#{resource_name} resource set to use:'#{type}' in config" +
-                " but Ruhoh::Resources::#{klass} does not exist."
-          }
-          abort
-        end
-      else
-        if @ruhoh.collections.registered.include?(resource_name)
-          Ruhoh::Resources.const_get(camelize(resource_name))
-        else
-          Ruhoh::Resources.const_get(:Pages)
-        end
-      end
-    end
-
-    def camelize(name)
-      name.to_s.split('_').map { |a| a.capitalize }.join
-    end
-  end
-
-  # Generic base implementation of a Collection class.
-  # All collections use this class by default
-  # unless the Collection class is explicitly defined for the resource.
-  class Collection
-    include Collectable
-  end
-
-end