usmu 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2ce1d8bd5d6466dc1d6a3fd7bee6e296e53dc14
-  data.tar.gz: 9bc408aade4f29424ab873ec38ba4efef844b9ec
+  metadata.gz: 9261434f327d1a56ce03785b20dd2ade1078901a
+  data.tar.gz: 3ad74fdce1d7f26fbe3dc3aebcffd95e4dbe78f0
 SHA512:
-  metadata.gz: adfea26ea6f7bc59ae8e95f7eaf9a3e795b40744933e6321fe2dacc2be4fa23f1dc38273edba618e6a80901c75ccc880ee3cda095f0667f1e96a48a7016c68b0
-  data.tar.gz: 9189d6c6248807abc95bd2c02b02f324b56eb89d99740565aac15b5339f6b2fc7e4586dd21c12cc9045321fdb18d456f285fd26fcd3d54c6b80a6976fcee48d2
+  metadata.gz: 48ef1c5da18dbe2406f196f03154e846c7f85c552b39cb3190abd69fd5fcc5d83ca7d74ff0e7bdcef351135b6da097ca09729840250ec702c88c20bef3a3b923
+  data.tar.gz: 7ad1d0fe258d9d137b0a671b9f55580696d9dc75919f709f2b1ca551c19ad3f9f0293f65d2ae27abf02183f310742f1a8dcdad6f355aed6e394005f6ff762b80

data/.gitignore

@@ -2,7 +2,7 @@
 /.yardoc
 /Gemfile*.lock
 /_yardoc/
-/coverage/
+/test/coverage/
 /doc/
 /pkg/
 /spec/reports/

data/.rspec

@@ -1,5 +1,6 @@
 --color
 -I test/spec
+-r turnip/rspec
 --require spec_helper
 --format documentation
 --no-profile

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  coverage_dir 'test/coverage'
+  add_filter 'test/'
+end

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 script: rake ci
 rvm:
+  - 1.9.3
   - 2.0
   - 2.1
   - ruby-head
@@ -13,6 +14,8 @@ gemfile:
   - Gemfile-jruby
 matrix:
   exclude:
+    - rvm: 1.9.3
+      gemfile: Gemfile-jruby
     - rvm: 2.0
       gemfile: Gemfile-jruby
     - rvm: 2.1

data/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+## Bug reports
+
+If you have a bug report, please include as much information as possible to help us diagnose the issue:
+
+*   A log of the console output if available
+*   A backtrace or log file (--trace and --log)
+*   If possible, a link to the source code for the website that is causing issues or a small example site that shows the
+    same issues.
+
+## Contributing code to usmu
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'rspec', spec_paths: ['test/spec'] do
+  watch(%r{^test/spec/.+_spec\.rb$})
+  watch(%r{^lib/usmu/(.+)\.rb$})     { |m| "test/spec/#{m[1]}_spec.rb" }
+  watch(%r{^test/spec/support})      { 'test/spec' }
+  watch('test/spec/spec_helper.rb')  { 'test/spec' }
+
+  # Turnip features and steps
+  #watch(%r{^spec/acceptance/(.+)\.feature$})
+  #watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/README.md

@@ -35,16 +35,17 @@ slim:
   :pretty: true
 ```
 
-## Contributing
+### Ruby Compatibility
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Officially, we support MRI 1.9.3 and onwards, however we recommend the latest versions. [1.9.3 is no longer maintained][ruby-maint]
+and is only supported here to help out the Rubinius and JRuby folks.
+
+We only officially support MRI, however Travis does run against both Rubinius and JRuby to track compatibility and
+there's a reasonable track record so far. Compatibility patches are very welcome.
 
   [gh-contrib]: https://github.com/usmu/usmu/graphs/contributors
   [gh-issues]: https://github.com/usmu/usmu/issues
   [license]: https://github.com/usmu/usmu/blob/master/LICENSE.md
   [tilt-support]: https://github.com/rtomayko/tilt/blob/master/README.md
   [template-options]: https://github.com/rtomayko/tilt/blob/master/docs/TEMPLATES.md
+  [ruby-maint]: https://bugs.ruby-lang.org/projects/ruby/wiki/ReleaseEngineering

data/Rakefile

@@ -2,8 +2,6 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'rspec/core/rake_task'
-require 'cucumber'
-require 'cucumber/rake/task'
 require 'usmu/version'
 
 def current_gems
@@ -11,23 +9,24 @@ def current_gems
 end
 
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = 'test/spec/**/*_spec.rb'
-end
-
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = 'test/features'
+  t.pattern = 'test/spec'
 end
 
 desc 'Run all test scripts'
-task :test => [:clean, :spec, :features]
+task :test => [:clean, :spec]
 
 desc 'Run CI test suite'
 task :ci => [:test]
 
 desc 'Clean up after tests'
 task :clean do
-  rm_r 'test/site/site' if File.exist? 'test/site/site'
-  current_gems.each {|f| rm f }
+  [
+      'test/coverage',
+      'test/site/site',
+      current_gems,
+  ].flatten.each do |f|
+    rm_r f if File.exist? f
+  end
 end
 
 namespace :gem do

data/bin/usmu

@@ -7,4 +7,8 @@ rescue LoadError
   require 'usmu/ui/console'
 end
 
-Usmu::Ui::Console.new(ARGV).execute
+begin
+  Usmu::Ui::Console.new(ARGV).execute
+rescue StandardError
+  exit 1
+end

data/lib/usmu.rb

@@ -1,3 +1,74 @@
+require 'logging'
+require 'rubygems'
+
+Logging.init :debug, :info, :success, :warn, :error, :fatal
+Logging.color_scheme(
+    'console',
+    :lines => {
+      :success  => :green,
+      :warn  => :yellow,
+      :error => :red,
+      :fatal => :red,
+    },
+)
+
+# This module contains all the code for the Usmu site generator
+module Usmu
+  @log = Logging.logger['Usmu']
+  @log.level = :all
+  @log.additive = false
+  @log.appenders = Logging.appenders.stdout(
+      'usmu-stdout',
+      :level => :info,
+      :layout => Logging.layouts.pattern(
+          :pattern => '%m\n',
+          :color_scheme => 'console',
+      ),
+  )
+
+  # Enable logging of all events to the console
+  #
+  # @return [void]
+  def self.verbose_logging
+    Logging.appenders['usmu-stdout'].level = :all
+    nil
+  end
+
+  # Disable all log messages other than errors. Warnings will be suppressed.
+  #
+  # @return [void]
+  def self.quiet_logging
+    Logging.appenders['usmu-stdout'].level = :error
+    nil
+  end
+
+  # Adds a file-based logger
+  #
+  # @param [String] filename Filename of the file to log to.
+  # @return [void]
+  def self.add_file_logger(filename)
+    @log.add_appenders(Logging.appenders.file(filename, :filename => filename, :level => :all))
+    nil
+  end
+
+  # :nocov:
+  # This is primarily a testing helper
+
+  # Disables stdout logging across the application. This is used to hide stack traces but still log them to the file
+  # log if it is in use.
+  #
+  # @return [void]
+  def self.disable_stdout_logging
+    @log.remove_appenders('usmu-stdout')
+    nil
+  end
+  # :nocov:
+
+  def self.plugins
+    @plugins ||= Usmu::Plugin.new
+  end
+end
+
 %W{
   usmu/version
   usmu/configuration
@@ -5,8 +76,6 @@
   usmu/layout
   usmu/page
   usmu/site_generator
+  usmu/plugin
+  usmu/plugin/core
 }.each { |f| require f }
-
-# This module contains all the code for the Usmu site generator
-module Usmu
-end

data/lib/usmu/configuration.rb

@@ -4,10 +4,12 @@ module Usmu
   # This class is used to represent a configuration file. This file should be a YAML file and called `usmu.yml`
   # by default.
   class Configuration
+    @log = Logging.logger[self]
+
     # @!attribute [r] config_file
     # @return [String] the name of the file used to load the configuration.
     attr_reader :config_file
-    # @!attribute [r] config_file
+    # @!attribute [r] config_dir
     # @return [String] the folder that the configuration was loaded from.
     attr_reader :config_dir
 
@@ -15,6 +17,7 @@ module Usmu
     #
     # @return [Usmu::Configuration]
     def self.from_file(filename)
+      @log.debug("Loading configuration from #{filename}")
       from_hash(YAML.load_file(filename), filename)
     end
 
@@ -31,6 +34,12 @@ module Usmu
       get_path @config['source'] || 'src'
     end
 
+    # @!attribute [r] source_files
+    # @return [Array<String>] a list of renderable files in the source folder
+    def source_files
+      get_files source_path
+    end
+
     # @!attribute [r] destination_path
     # @return [String] the full path to the destination folder
     def destination_path
@@ -43,6 +52,12 @@ module Usmu
       get_path @config['layouts'] || 'layouts'
     end
 
+    # @!attribute [r] layouts_files
+    # @return [Array<String>] a list of renderable files in the layouts folder
+    def layouts_files
+      get_files layouts_path
+    end
+
     # An index accessor to directly access the configuration file. It should be noted that `['source']` and
     # `#source_path` and other similar pairs will have different values. `['source']` is the raw value from the
     # configuration file while the latter is a path on the system, potentially altered by the path from the current
@@ -63,6 +78,7 @@ module Usmu
     # @see Usmu::Configuration.from_file
     # @see Usmu::Configuration.from_hash
     def initialize(hash, config_path)
+      @log = Logging.logger[self]
       @config = hash
       @config_file = config_path
       @config_dir = config_path ? File.dirname(config_path) : nil
@@ -79,5 +95,28 @@ module Usmu
         File.join(@config_dir, path)
       end
     end
+
+    # Helper to determine if a filename is excluded according to the exclude configuration parameter.
+    #
+    # @return [Boolean]
+    def excluded?(filename)
+      flags = defined?(File::FNM_EXTGLOB) ? File::FNM_EXTGLOB | File::FNM_PATHNAME : File::FNM_PATHNAME
+      (@config['exclude'] || []).each do |f|
+        f += '**/*' if f[-1] == '/'
+        return true if File.fnmatch(f, filename, flags)
+      end
+      false
+    end
+
+    # Helper function to search a directory recursively and return a list of files that are renderable.
+    #
+    # @param [String] directory the directory to search
+    # @param [Boolean] layout is this directory a layouts_path
+    # @return [Array<Usmu::Layout>, Array<Usmu::StaticFile>] Either an array of Layouts or StaticFiles in the directory
+    def get_files(directory)
+      Dir["#{directory}/**/*"].select {|f| !f.match(/\.meta.yml$/) }.map do |f|
+        f[(directory.length + 1)..f.length]
+      end.select {|f| not excluded? f}
+    end
   end
 end

data/lib/usmu/layout.rb

@@ -42,7 +42,8 @@ module Usmu
       end
       @metadata = metadata
 
-      @parent = Layout.find_layout(configuration, metadata['layout'])
+      @parent = nil
+      @parent = Layout.find_layout(configuration, self.metadata['layout'])
     end
 
     # @!attribute [r] metadata
@@ -53,9 +54,9 @@ module Usmu
     # This will include any metadata from parent templates and default metadata
     def metadata
       if @parent.nil?
-        @metadata.deep_merge(@configuration['default meta'] || {})
+        (@configuration['default meta'] || {}).dup.deep_merge!(@metadata)
       else
-        @metadata.deep_merge(@parent.metadata)
+        @parent.metadata.deep_merge!(@metadata)
       end
     end
 
@@ -75,10 +76,25 @@ module Usmu
       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
-      'html'
+      case @type
+        when 'erb', 'rhtml', 'erubis', 'liquid'
+          nil
+        when 'coffee'
+          'js'
+        when 'less', 'sass', 'scss'
+          'css'
+        else
+          'html'
+      end
     end
 
     # @!attribute [r] output_filename
@@ -86,7 +102,11 @@ module Usmu
     #
     # Returns the filename to use for the output directory with any modifications to the input filename required.
     def output_filename
-      @name[0..@name.rindex('.')] + output_extension
+      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
@@ -100,13 +120,16 @@ module Usmu
     #   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.class.name == 'String'
+      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
@@ -160,7 +183,7 @@ module Usmu
     #
     # @return [Hash]
     def get_variables(variables)
-      variables.deep_merge(metadata).deep_merge({site: @configuration})
+      {site: @configuration}.deep_merge!(metadata).deep_merge!(variables)
     end
   end
 end

data/lib/usmu/page.rb

@@ -1,3 +1,4 @@
+require 'usmu/layout'
 
 module Usmu
   # Represents a page in the source directory of the website.

data/lib/usmu/plugin.rb

@@ -0,0 +1,65 @@
+
+module Usmu
+  class Plugin
+    def initialize
+      @log = Logging.logger['Usmu::Plugin']
+    end
+
+    # Loads all plugins that are available as gems. This is determined by looking at the gem's name. Anything prefixed
+    # with the string 'usmu-' will be recognised as a plugin. This will load the gem according to the RubyGems
+    # recommendations for naming schemes. A gem named `usmu-s3_uploader` will be loaded by requiring the path
+    # `'usmu/s3_uploader'` and then then the class `Usmu::S3Uploader` will be instantiated as the plugins interface.
+    #
+    # @return [void]
+    def load_plugins
+      loaded = []
+      @log.debug('Loading plugins')
+      @log.debug('Loaded Usmu::Plugin::Core')
+      plugins.push Usmu::Plugin::Core.new
+      Gem::Specification.find_all { |s| s.name =~ /^usmu-/ }.each do |spec|
+        load_path = spec.name.gsub('-', '/')
+        require load_path
+
+        unless loaded.include? load_path
+          loaded << load_path
+          klass = load_path.split('/').map {|s| s.split('_').map(&:capitalize).join }.join('::')
+          @log.debug("Loading plugin #{klass} from '#{load_path}'")
+          plugins.push plugin_get(klass)
+        end
+      end
+      @log.debug("Loaded: #{plugins.inspect}")
+    end
+
+    # @!attribute [r] plugins
+    # @return [Array] a list of all plugins discovered and loaded.
+    def plugins
+      @plugins ||= []
+    end
+
+    # Call all plugins and collate any data returned. nil can be returned explicitly to say this plugin has nothing to
+    # return.
+    # @param [Symbol] method The name of the method to call. This should be namespaced somehow. For example, a plugin
+    #                        called `usmu-s3` could use the method namespace `s3` and have a hook called `:s3_upload`
+    # @param [Array] args The arguments to pass through to plugins. Can be empty.
+    def invoke(method, *args)
+      @log.debug("Invoking plugin API #{method}")
+      plugins.map do |p|
+        if p.respond_to? method
+          @log.debug("Sending message to #{p.class.name}")
+          p.public_send method, *args
+        else
+          nil
+        end
+      end.select {|i| i}
+    end
+
+    private
+
+    def plugin_get(klass)
+      object.const_get(klass).new
+    rescue NameError
+      # Ruby 1.9.3, dowp
+      klass.split('::').reduce(Object) {|memo, o| memo.const_get o }.new
+    end
+  end
+end