usmu 0.2.1 → 0.2.2

data/test/spec/site_generator_spec.rb

@@ -11,7 +11,7 @@ RSpec.describe Usmu::SiteGenerator do
 
   it 'should have a list of renderable items' do
     expect(generator.respond_to? :renderables).to eq(true)
-    expect(generator.renderables.map {|r| r.name}.sort).to eq(%w{default.md embedded.md index.md robots.txt})
+    expect(generator.renderables.map {|r| r.name}.sort).to eq(%w{.dotfiletest.txt default.md embedded.md index.md robots.txt})
   end
 
   it 'should have pages' do
@@ -21,7 +21,7 @@ RSpec.describe Usmu::SiteGenerator do
 
   it 'should have files' do
     expect(generator.respond_to? :files).to eq(true)
-    expect(generator.files.map {|f| f.name}.sort).to eq(%w{robots.txt})
+    expect(generator.files.map {|f| f.name}.sort).to eq(%w{.dotfiletest.txt robots.txt})
   end
 
   it 'should be able to generate a site' do

data/test/spec/{layout_spec.rb → template/layout_spec.rb}

@@ -1,18 +1,18 @@
 require 'support/shared_layout'
-require 'usmu/layout'
+require 'usmu/template/layout'
 
-RSpec.describe Usmu::Layout do
+RSpec.describe Usmu::Template::Layout do
   it_behaves_like 'an embeddable layout'
 
   let(:configuration) { Usmu::Configuration.from_hash({}) }
 
   it 'uses the \'layouts\' folder' do
-    layout = Usmu::Layout.new(configuration, 'html.slim', 'slim', "head\nbody", {})
+    layout = Usmu::Template::Layout.new(configuration, 'html.slim', 'slim', "head\nbody", {})
     expect(layout.send :content_path).to eq('layouts')
   end
 
   it 'has an input path' do
-    layout = Usmu::Layout.new(configuration, 'html.slim', 'slim', "head\nbody", {})
+    layout = Usmu::Template::Layout.new(configuration, 'html.slim', 'slim', "head\nbody", {})
     expect(layout.respond_to? :input_path).to eq(true)
     expect(layout.input_path).to eq('layouts/html.slim')
   end

data/test/spec/{page_spec.rb → template/page_spec.rb}

@@ -1,18 +1,18 @@
 require 'support/shared_layout'
-require 'usmu/page'
+require 'usmu/template/page'
 
-RSpec.describe Usmu::Page do
+RSpec.describe Usmu::Template::Page do
   it_behaves_like 'an embeddable layout'
 
   let(:configuration) { Usmu::Configuration.from_hash({}) }
 
   it 'uses the \'source\' folder' do
-    page = Usmu::Page.new(configuration, 'index.md', 'md', '# test', {})
+    page = Usmu::Template::Page.new(configuration, 'index.md', 'md', '# test', {})
     expect(page.send :content_path).to eq('src')
   end
 
   it 'has an input path' do
-    page = Usmu::Page.new(configuration, 'index.md', 'md', '# test', {})
+    page = Usmu::Template::Page.new(configuration, 'index.md', 'md', '# test', {})
     expect(page.respond_to? :input_path).to eq(true)
     expect(page.input_path).to eq('src/index.md')
   end

data/test/spec/{static_file_spec.rb → template/static_file_spec.rb}

@@ -1,26 +1,26 @@
 require 'support/shared_layout'
-require 'usmu/static_file'
+require 'usmu/template/static_file'
 
-RSpec.describe Usmu::StaticFile do
+RSpec.describe Usmu::Template::StaticFile do
   it_behaves_like 'a renderable file'
 
   let(:configuration) { Usmu::Configuration.from_file('test/site/usmu.yml') }
 
   it 'uses the \'source\' folder' do
-    file = Usmu::StaticFile.new(configuration, 'robots.txt')
+    file = Usmu::Template::StaticFile.new(configuration, 'robots.txt')
     rendered = file.render
     expect(rendered).to eq(File.read('test/expected-site/robots.txt'))
   end
 
   it 'has an input path' do
     configuration = Usmu::Configuration.from_hash({})
-    page = Usmu::StaticFile.new(configuration, 'robots.txt', 'txt', '', {})
+    page = Usmu::Template::StaticFile.new(configuration, 'robots.txt', 'txt', '', {})
     expect(page.respond_to? :input_path).to eq(true)
     expect(page.input_path).to eq('src/robots.txt')
   end
 
   it 'has an output filename that matches input' do
-    file = Usmu::StaticFile.new(configuration, 'robots.txt')
+    file = Usmu::Template::StaticFile.new(configuration, 'robots.txt')
     expect(file.output_filename).to eq('robots.txt')
   end
 end

data/usmu-jruby.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'slim', '~> 2.1'
+  spec.add_dependency 'slim', '~> 3.0'
   spec.add_dependency 'tilt', '~> 2.0'
   spec.add_dependency 'kramdown', '~> 1.5'
   spec.add_dependency 'deep_merge', '~> 1.0'

data/usmu.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'slim', '~> 2.1'
+  spec.add_dependency 'slim', '~> 3.0'
   spec.add_dependency 'tilt', '~> 2.0'
   spec.add_dependency 'redcarpet', '~> 3.2', '>= 3.2.1'
   spec.add_dependency 'deep_merge', '~> 1.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usmu
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Matthew Scharley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-29 00:00:00.000000000 Z
+date: 2014-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slim
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -242,6 +242,7 @@ files:
 - ".simplecov"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - Gemfile-jruby
@@ -253,25 +254,36 @@ files:
 - cucumber.yml
 - lib/usmu.rb
 - lib/usmu/configuration.rb
-- lib/usmu/layout.rb
-- lib/usmu/page.rb
 - lib/usmu/plugin.rb
 - lib/usmu/plugin/core.rb
 - lib/usmu/site_generator.rb
-- lib/usmu/static_file.rb
+- lib/usmu/template/helpers.rb
+- lib/usmu/template/include.rb
+- lib/usmu/template/layout.rb
+- lib/usmu/template/page.rb
+- lib/usmu/template/static_file.rb
 - lib/usmu/ui.rb
 - lib/usmu/ui/console.rb
 - lib/usmu/version.rb
+- share/init-site/.gitignore
+- share/init-site/Gemfile
+- share/init-site/layouts/html.slim
+- share/init-site/source/index.md
+- share/init-site/usmu.yml
+- test/expected-site/.dotfiletest.txt
 - test/expected-site/default.html
 - test/expected-site/embedded.html
 - test/expected-site/index.html
 - test/expected-site/robots.txt
+- test/site/content/.dotfiletest.txt
 - test/site/content/default.md
 - test/site/content/embedded.md
 - test/site/content/embedded.meta.yml
 - test/site/content/index.md
 - test/site/content/index.meta.yml
 - test/site/content/robots.txt
+- test/site/includes/footer.meta.yml
+- test/site/includes/footer.slim
 - test/site/layouts/embedded.meta.yml
 - test/site/layouts/embedded.slim
 - test/site/layouts/html.meta.yml
@@ -280,15 +292,15 @@ files:
 - test/spec/acceptance/full_site_build.feature
 - test/spec/acceptance/steps/full_site_build_steps.rb
 - test/spec/configuration_spec.rb
-- test/spec/layout_spec.rb
 - test/spec/mock/usmu/mock_plugin.rb
-- test/spec/page_spec.rb
 - test/spec/plugin/core_spec.rb
 - test/spec/plugin_spec.rb
 - test/spec/site_generator_spec.rb
 - test/spec/spec_helper.rb
-- test/spec/static_file_spec.rb
 - test/spec/support/shared_layout.rb
+- test/spec/template/layout_spec.rb
+- test/spec/template/page_spec.rb
+- test/spec/template/static_file_spec.rb
 - test/spec/ui/console_spec.rb
 - usmu-jruby.gemspec
 - usmu.gemspec
@@ -317,16 +329,20 @@ signing_key:
 specification_version: 4
 summary: A static site generator with a web-based frontend for editing.
 test_files:
+- test/expected-site/.dotfiletest.txt
 - test/expected-site/default.html
 - test/expected-site/embedded.html
 - test/expected-site/index.html
 - test/expected-site/robots.txt
+- test/site/content/.dotfiletest.txt
 - test/site/content/default.md
 - test/site/content/embedded.md
 - test/site/content/embedded.meta.yml
 - test/site/content/index.md
 - test/site/content/index.meta.yml
 - test/site/content/robots.txt
+- test/site/includes/footer.meta.yml
+- test/site/includes/footer.slim
 - test/site/layouts/embedded.meta.yml
 - test/site/layouts/embedded.slim
 - test/site/layouts/html.meta.yml
@@ -335,14 +351,14 @@ test_files:
 - test/spec/acceptance/full_site_build.feature
 - test/spec/acceptance/steps/full_site_build_steps.rb
 - test/spec/configuration_spec.rb
-- test/spec/layout_spec.rb
 - test/spec/mock/usmu/mock_plugin.rb
-- test/spec/page_spec.rb
 - test/spec/plugin/core_spec.rb
 - test/spec/plugin_spec.rb
 - test/spec/site_generator_spec.rb
 - test/spec/spec_helper.rb
-- test/spec/static_file_spec.rb
 - test/spec/support/shared_layout.rb
+- test/spec/template/layout_spec.rb
+- test/spec/template/page_spec.rb
+- test/spec/template/static_file_spec.rb
 - test/spec/ui/console_spec.rb
 has_rdoc: 

data/lib/usmu/layout.rb

@@ -1,189 +0,0 @@
-require 'tilt'
-require 'deep_merge'
-require 'usmu/static_file'
-
-module Usmu
-  # Class to represent files templated with a Tilt library. Most of the custom rendering logic is contained here.
-  class Layout < StaticFile
-    # @!attribute [r] type
-    # @return [String] the type of file this is. This is used to determine which template engine to use.
-    attr_reader :type
-
-    # @param configuration [Usmu::Configuration] The configuration for the website we're generating.
-    # @param name [String] The name of the file in the source directory.
-    # @param type [String] The type of template to use with the file. Used for testing purposes.
-    # @param content [String] The content of the file. Used for testing purposes.
-    # @param metadata [String] The metadata for the file. Used for testing purposes.
-    def initialize(configuration, name, type = nil, content = nil, metadata = nil)
-      super(configuration, name)
-
-      if type.nil?
-        type = name.split('.').last
-        unless ::Tilt.default_mapping[type]
-          raise "Templates of type '#{type}' aren't currently supported by Tilt. " +
-                'Do you have the required gem installed?'
-        end
-      end
-      @type = type
-      path = File.join("#{content_path}", "#{name[0, name.length - type.length - 1]}")
-
-      if content.nil?
-        content = File.read("#{path}.#{type}")
-      end
-      @content = content
-
-      if metadata.nil?
-        meta_file = "#{path}.meta.yml"
-        metadata = if File.exist? meta_file
-          YAML.load_file(meta_file)
-        else
-          {}
-        end
-      end
-      @metadata = metadata
-
-      @parent = nil
-      @parent = Layout.find_layout(configuration, self.metadata['layout'])
-    end
-
-    # @!attribute [r] metadata
-    # @return [Hash] the metadata associated with this layout.
-    #
-    # Returns the metadata associated with this layout.
-    #
-    # This will include any metadata from parent templates and default metadata
-    def metadata
-      if @parent.nil?
-        (@configuration['default meta'] || {}).dup.deep_merge!(@metadata)
-      else
-        @parent.metadata.deep_merge!(@metadata)
-      end
-    end
-
-    # Renders the file with any templating language required and returns the result
-    #
-    # @param variables [Hash] Variables to be used in the template.
-    # @return [String] The rendered file.
-    def render(variables = {})
-      content = template_class.new("#{@name}.#{@type}", 1, @configuration[provider_name]) { @content }.
-          render(nil, get_variables(variables))
-      has_cr = content.index("\r")
-      content += (has_cr ? "\r\n" : "\n") if content[-1] != "\n"
-      if @parent.nil?
-        content
-      else
-        @parent.render({'content' => content})
-      end
-    end
-
-    # @!attribute [r] input_path
-    # @return [String] the full path to the file in the source directory
-    def input_path
-      File.join(content_path, @name)
-    end
-
-    # @!attribute [r] output_extension
-    # @return [String] the extension to use with the output file.
-    def output_extension
-      case @type
-        when 'erb', 'rhtml', 'erubis', 'liquid'
-          nil
-        when 'coffee'
-          'js'
-        when 'less', 'sass', 'scss'
-          'css'
-        else
-          'html'
-      end
-    end
-
-    # @!attribute [r] output_filename
-    # @return [String] the filename to use in the output directory.
-    #
-    # Returns the filename to use for the output directory with any modifications to the input filename required.
-    def output_filename
-      if output_extension
-        @name[0..@name.rindex('.')] + output_extension
-      else
-        @name[0..@name.rindex('.') - 1]
-      end
-    end
-
-    # Static method to create a layout for a given configuration by it's name if it exists. This differs from
-    # `#initialise` in that it allows different types of values to be supplied as the name and will not fail if name
-    # is nil
-    #
-    # @param configuration [Usmu::Configuration] The configuration to use for the search
-    # @param name [String]
-    #   If name is a string then search for a template with that name. Name here should not include
-    #   file extension, eg. body not body.slim. If name is not a string then it will be returned verbatim. This means
-    #   that name is nilable and can also be passed in as an Usmu::Layout already for testing purposes.
-    # @return [Usmu::Layout]
-    def self.find_layout(configuration, name)
-      if name === 'none'
-        nil
-      elsif name.class.name == 'String'
-        Dir["#{configuration.layouts_path}/#{name}.*"].each do |f|
-          filename = File.basename(f)
-          if filename != "#{name}.meta.yml"
-            return new(configuration, f[(configuration.layouts_path.length + 1)..f.length])
-          end
-        end
-        nil
-      else
-        name
-      end
-    end
-
-    # Tests if a given file is a valid Tilt template based on the filename.
-    #
-    # @param folder_type [String]
-    #   One of `"source"` or `"layout"` depending on where the template is in the source tree.
-    #   Not used by Usmu::Layout directly but intended to be available for future API.
-    # @param name [String] The filename to be tested.
-    # @return [Boolean]
-    def self.is_valid_file?(folder_type, name)
-      type = name.split('.').last
-      ::Tilt.default_mapping[type] ? true : false
-    end
-
-    protected
-
-    # @!attribute [r] template_class
-    # @return [Tilt::Template] the Tilt template engine for this layout
-    def template_class
-      @template_class ||= ::Tilt.default_mapping[@type]
-    end
-
-    # @!attribute [r] provider_name
-    # @return [String] the Tilt template engine's name for this layout
-    #
-    # Returns the Tilt template engine's name for this layout.
-    #
-    # This is used to determine which settings to use from the configuration file.
-    def provider_name
-      Tilt.default_mapping.lazy_map[@type].select {|x| x[0] == template_class.name }.first[1].split('/').last
-    end
-
-    # @!attribute [r] content_path
-    # @return [string] the base path to the files used by this class.
-    #
-    # Returns the base path to the files used by this class.
-    #
-    # This folder should be the parent folder for the file named by the name attribute.
-    #
-    # @see #name
-    def content_path
-      @configuration.layouts_path
-    end
-
-    private
-
-    # Utility function which collates variables to pass to the template engine.
-    #
-    # @return [Hash]
-    def get_variables(variables)
-      {site: @configuration}.deep_merge!(metadata).deep_merge!(variables)
-    end
-  end
-end

data/lib/usmu/page.rb

@@ -1,20 +0,0 @@
-require 'usmu/layout'
-
-module Usmu
-  # Represents a page in the source directory of the website.
-  class Page < Layout
-    protected
-
-    # @!attribute [r] content_path
-    # @return [string] the base path to the files used by this class.
-    #
-    # Returns the base path to the files used by this class.
-    #
-    # This folder should be the parent folder for the file named by the name attribute.
-    #
-    # @see #name
-    def content_path
-      @configuration.source_path
-    end
-  end
-end