usmu 0.2.1 → 0.2.2

data/lib/usmu/template/layout.rb

@@ -0,0 +1,198 @@
+require 'tilt'
+require 'deep_merge'
+require 'usmu/template/helpers'
+require 'usmu/template/static_file'
+
+module Usmu
+  module Template
+    # 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(helpers, 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::Template::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::Template::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
+
+      # @!attribute [r] helpers
+      # @return [Usmu::Template::Helpers] the Helpers class to use as a scope for templates
+      def helpers
+        @helpers ||= Usmu::Template::Helpers.new(@configuration)
+      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
+end

data/lib/usmu/template/page.rb

@@ -0,0 +1,22 @@
+require 'usmu/template/layout'
+
+module Usmu
+  module Template
+    # 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
+end

data/lib/usmu/template/static_file.rb

@@ -0,0 +1,50 @@
+require 'usmu/configuration'
+
+module Usmu
+  module Template
+    # Represents a static file which should be transferred to the destination unchanged. This also acts as the base
+    # class for all layouts and page types. The basic interface defined here is used to process all types of files.
+    class StaticFile
+      @log = Logging.logger[self]
+
+      # @!attribute [r] name
+      # @return [String] the name of the file in the source directory
+      attr_reader :name
+
+      # @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. Not used for StaticFile.
+      #   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)
+        @configuration = configuration
+        @name = name
+        @type = type
+        @content = content
+      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 || File.read(input_path)
+      end
+
+      # @!attribute [r] input_path
+      # @return [String] the full path to the file in the source directory
+      def input_path
+        File.join(@configuration.source_path, @name)
+      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
+        @name
+      end
+    end
+  end
+end

data/lib/usmu/version.rb

@@ -1,5 +1,5 @@
 
 module Usmu
   # The current version string for the gem
-  VERSION = '0.2.1'
+  VERSION = '0.2.2'
 end

data/share/init-site/.gitignore

@@ -0,0 +1,2 @@
+/site
+/Gemfile.lock

data/share/init-site/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'usmu'
+
+## Add any Usmu plugins you need for your site here.
+#gem 'usmu-s3'

data/share/init-site/layouts/html.slim

@@ -0,0 +1,8 @@
+doctype html
+html
+  head
+    meta http-equiv="Content-Type" content="text/html; charset=utf-8"
+    title #{site.title}
+
+  body
+    | #{{content}}

data/share/init-site/source/index.md

@@ -0,0 +1,3 @@
+# It works!
+
+Welcome to your new Usmu website! Feel free to look around and find out what's in store for you.

data/share/init-site/usmu.yml

@@ -0,0 +1,3 @@
+---
+
+title: Example site

data/test/expected-site/.dotfiletest.txt

@@ -0,0 +1 @@
+Maybe we want to include a dotfile in our website? I don't know why, but we should copy these as well.

data/test/expected-site/default.html

@@ -10,5 +10,9 @@
       <p>No metadata for this file. Uh oh!</p>
       
     </div>
+    <footer>
+      Copyright &copy; Testers Inc.
+    </footer>
+    
   </body>
 </html>

data/test/expected-site/embedded.html

@@ -9,7 +9,14 @@
         <h1>Embedded test</h1>
         
       </div>
+      <footer>
+        Copyright &copy; Special Corp Pty. Ltd.
+      </footer>
       
     </div>
+    <footer>
+      Copyright &copy; Testers Inc.
+    </footer>
+    
   </body>
 </html>

data/test/expected-site/index.html

@@ -10,5 +10,9 @@
       <p>This is some test content</p>
       
     </div>
+    <footer>
+      Copyright &copy; Testers Inc.
+    </footer>
+    
   </body>
 </html>

data/test/site/content/.dotfiletest.txt

@@ -0,0 +1 @@
+Maybe we want to include a dotfile in our website? I don't know why, but we should copy these as well.

data/test/site/includes/footer.meta.yml

@@ -0,0 +1,2 @@
+---
+name: Testers Inc.

data/test/site/includes/footer.slim

@@ -0,0 +1 @@
+footer Copyright © #{name}

data/test/site/layouts/embedded.slim

@@ -1,2 +1,4 @@
 .embedded
   | #{{content}}
+
+== include 'footer', name: 'Special Corp Pty. Ltd.'

data/test/site/layouts/html.slim

@@ -6,3 +6,5 @@ html
   body
     #content
       | #{{content}}
+
+    == include 'footer'

data/test/spec/acceptance/full_site_build.feature

@@ -4,8 +4,13 @@ Feature:
   As a user
   I would like to generate a static website
 
+  Scenario:
+    When I run usmu with the arguments "init tmp"
+    Then the directory "tmp" should match "share/init-site"
+
+
   Scenario:
     Given I have a site at "test/site"
-    When I generate the site
-    Then the destination directory should match "test/expected-site"
+    When I run usmu with the arguments "generate"
+    Then the directory "test/site/site" should match "test/expected-site"
     And the modification time for the input file "index.md" should match the output file "index.html"

data/test/spec/acceptance/steps/full_site_build_steps.rb

@@ -5,12 +5,17 @@ step 'I have a site at :location' do |location|
   @location = "#{location}/usmu.yml"
 end
 
-step 'I generate the site' do
-  @site = Usmu::Ui::Console.new(['generate', '--config', @location])
+step 'I run usmu with the arguments :args' do |args|
+  args = args.split(' ')
+  if @location
+    args << '--config' << @location
+  end
+  args << '--trace'
+  @site = Usmu::Ui::Console.new(args)
 end
 
-step 'the destination directory should match :test_folder' do |test_folder|
-  run = %W{diff -qr #{@site.configuration.destination_path} #{test_folder}}
+step 'the directory :destination should match :test_folder' do |destination, test_folder|
+  run = %W{diff -qr --strip-trailing-cr #{destination} #{test_folder}}
   Open3.popen2e(*run) do |i, o, t|
     output = run.join(' ') + "\n" + o.read
     fail output if t.value != 0

data/test/spec/configuration_spec.rb

@@ -7,6 +7,7 @@ RSpec.describe Usmu::Configuration do
           'source' => 'source',
           'destination' => 'destination',
           'layouts' => 'templates',
+          'includes' => 'includes',
       }
       @configuration = Usmu::Configuration.from_hash(hash, 'test/usmu.yaml')
     end
@@ -22,6 +23,10 @@ RSpec.describe Usmu::Configuration do
     it 'to layouts' do
       expect(@configuration.layouts_path).to eq('test/templates')
     end
+
+    it 'to includes' do
+      expect(@configuration.includes_path).to eq('test/includes')
+    end
   end
 
   context 'should have a default path' do
@@ -41,32 +46,48 @@ RSpec.describe Usmu::Configuration do
     it 'for layouts' do
       expect(@configuration.layouts_path).to eq('layouts')
     end
+
+    it 'for includes' do
+      expect(@configuration.includes_path).to eq('includes')
+    end
   end
 
   it 'should have a list of source files' do
     @configuration = Usmu::Configuration.from_hash({})
-    allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/test.md))
+    allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/test.md))
     expect(@configuration.source_files).to eq(%w(index.md test.md))
   end
 
   it 'should ignore metadata files in the source folder' do
     @configuration = Usmu::Configuration.from_hash({})
-    allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/index.meta.yml src/test.md))
+    allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/index.meta.yml src/test.md))
     expect(@configuration.source_files).to eq(%w(index.md test.md))
   end
 
   it 'should have a list of layouts files' do
     @configuration = Usmu::Configuration.from_hash({})
-    allow(Dir).to receive(:'[]').with('layouts/**/*').and_return(%w(layouts/html.slim layouts/page.slim))
+    allow(Dir).to receive(:'[]').with('layouts/**/{*,.??*}').and_return(%w(layouts/html.slim layouts/page.slim))
     expect(@configuration.layouts_files).to eq(%w(html.slim page.slim))
   end
 
   it 'should ignore metadata files in the layouts folder' do
     @configuration = Usmu::Configuration.from_hash({})
-    allow(Dir).to receive(:'[]').with('layouts/**/*').and_return(%w(layouts/html.slim layouts/html.meta.yml layouts/page.slim))
+    allow(Dir).to receive(:'[]').with('layouts/**/{*,.??*}').and_return(%w(layouts/html.slim layouts/html.meta.yml layouts/page.slim))
     expect(@configuration.layouts_files).to eq(%w(html.slim page.slim))
   end
 
+  it 'should have a list of includes files' do
+    @configuration = Usmu::Configuration.from_hash({})
+    allow(Dir).to receive(:'[]').with('includes/**/{*,.??*}').and_return(%w(includes/footer.slim))
+    expect(@configuration.includes_files).to eq(%w(footer.slim))
+  end
+
+  it 'should ignore metadata files in the includes folder' do
+    @configuration = Usmu::Configuration.from_hash({})
+    allow(Dir).to receive(:'[]').with('includes/**/{*,.??*}').and_return(%w(includes/footer.slim includes/footer.meta.yml))
+    expect(@configuration.includes_files).to eq(%w(footer.slim))
+  end
+
   it 'should remember arbitrary configuration' do
     configuration = Usmu::Configuration.from_hash({:test => 'foo'})
     expect(configuration[:test]).to eq('foo')
@@ -75,37 +96,37 @@ RSpec.describe Usmu::Configuration do
   context 'should exclude files from source' do
     it 'as specified' do
       @configuration = Usmu::Configuration.from_hash({'exclude' => ['foo.md']})
-      allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/foo.md))
+      allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/foo.md))
       expect(@configuration.source_files).to eq(%w(index.md))
     end
 
     it 'in ignored folders if trailing "/" is used' do
       @configuration = Usmu::Configuration.from_hash({'exclude' => ['test/']})
-      allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/test/foo/test.md src/test/foo.md))
+      allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/test/foo/test.md src/test/foo.md))
       expect(@configuration.source_files).to eq(%w(index.md))
     end
 
     it 'and honor *' do
       @configuration = Usmu::Configuration.from_hash({'exclude' => ['*/foo.md']})
-      allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/test/foo/foo.md src/test/foo.md))
+      allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/test/foo/foo.md src/test/foo.md))
       expect(@configuration.source_files).to eq(%w(index.md test/foo/foo.md))
     end
 
     it 'and * ignores folders without a trailing /' do
       @configuration = Usmu::Configuration.from_hash({'exclude' => ['*']})
-      allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/test/foo.md src/test.md))
+      allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/test/foo.md src/test.md))
       expect(@configuration.source_files).to eq(%w(test/foo.md))
     end
 
     it 'and honor **' do
       @configuration = Usmu::Configuration.from_hash({'exclude' => ['**/foo.md']})
-      allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/test/foo/foo.md src/test/foo.md))
+      allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/test/foo/foo.md src/test/foo.md))
       expect(@configuration.source_files).to eq(%w(index.md))
     end
 
     it 'and honor []' do
       @configuration = Usmu::Configuration.from_hash({'exclude' => ['[ab].md']})
-      allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/a.md src/b.md))
+      allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/a.md src/b.md))
       expect(@configuration.source_files).to eq(%w(index.md))
     end
 
@@ -114,26 +135,26 @@ RSpec.describe Usmu::Configuration do
     if defined?(File::FNM_EXTGLOB)
       it 'and honor {a,b}' do
         @configuration = Usmu::Configuration.from_hash({'exclude' => ['{a,b}.md']})
-        allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/a.md src/b.md))
+        allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/a.md src/b.md))
         expect(@configuration.source_files).to eq(%w(index.md))
       end
     end
 
     it 'and honor \\ as an escape' do
       @configuration = Usmu::Configuration.from_hash({'exclude' => ['\*.md']})
-      allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/*.md))
+      allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/*.md))
       expect(@configuration.source_files).to eq(%w(index.md))
     end
 
     it 'and honor ?' do
       @configuration = Usmu::Configuration.from_hash({'exclude' => ['?.md']})
-      allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/a.md src/b.md))
+      allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/a.md src/b.md))
       expect(@configuration.source_files).to eq(%w(index.md))
     end
 
     it 'and ignore files inside folders specified via globs with trailing "/"' do
       @configuration = Usmu::Configuration.from_hash({'exclude' => ['test/*/']})
-      allow(Dir).to receive(:'[]').with('src/**/*').and_return(%w(src/index.md src/test/foo/foo.md src/test/foo.md))
+      allow(Dir).to receive(:'[]').with('src/**/{*,.??*}').and_return(%w(src/index.md src/test/foo/foo.md src/test/foo.md))
       expect(@configuration.source_files).to eq(%w(index.md test/foo.md))
     end
   end