usmu 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82edd4386ce8ad7e313db42fcb53ae4b908f8988
-  data.tar.gz: bf0bbc5db654e595fccfaa5d65965976d2d2b75d
+  metadata.gz: a5993d2cf7f8ba77f906f2fdca5ea2bd0d7f8368
+  data.tar.gz: 17e1c5a84df4715b6042c79fefe3ea66966b089b
 SHA512:
-  metadata.gz: 19a6e9d124cefab1e4068b5c29da0eb1656cf7e10bf844e5b7ae29fc03d7e39966e5d11785a13fdf28eeb8e6d7d14f5acf41c37cda6cf51dbdc5d9b99df24860
-  data.tar.gz: 181da46641fa0d63e0359f069bba71d2deca24fac77fb03ee801be16bebc769361d3c5fd4584023f039a38616b24c52d32a198f52fc4f5e515eac0823cc6f187
+  metadata.gz: 5ff5e410972c66371dfbef17b8fcac40371f1624ce93d1679cc3bc1bd77501d3827f2a45a9b97141be01775367054ce9f2481959cc79a59ae270a21cd195ddef
+  data.tar.gz: d855520486e29adc40c4f2a33688be8cb0348d5aa8714372c3aba965eb1be0f89a060819891d4b76492144085b221848c0bc517db46f626a3d395628ccdcd4e4

data/.travis.yml

@@ -6,22 +6,18 @@ rvm:
   - 2.1
   - 2.2
   - ruby-head
-  - mruby-head
-  - rbx-2.1
-  - rbx-2.2
-  - rbx-2.3
+  #- mruby-head
+  #- rbx-2.1
+  #- rbx-2.2
+  #- rbx-2.3
   - rbx-2.4
+  - jruby
+  - jruby-head
 matrix:
   include:
     - rvm: jruby
-      gemfile: Gemfile-jruby
-    - rvm: jruby
-      gemfile: Gemfile-jruby
       env: JRUBY_OPTS='--2.0'
     - rvm: jruby-head
-      gemfile: Gemfile-jruby
-    - rvm: jruby-head
-      gemfile: Gemfile-jruby
       env: JRUBY_OPTS='--2.0'
   allow_failures:
     - rvm: 1.9.3

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Usmu Change Log
 
+## 0.3.3
+
+Matthew Scharley <matt.scharley@gmail.com>
+
+* Disallow mutant on 2.2 (f6afd151d54c8fefb6a9af68a7cea1bae8f32265)
+* Cleanup gem builds to use the same gemspec (48cce89d6936e0b0668bf9714989d786ac573aaf)
+* Cleanup Travis since we don't need includes (as much) (8453421218e0b63755bccae6b2e01754225bbe7a)
+* [skip ci] Add a minimum Ruby requirement (c90711ac1e41c8a9973e987aa308a88c951e05dc)
+* Hopefully fix rbx (e6a51d07986b4347394ae3b571bb6b2a16ad1db3)
+* [skip ci] minor cleanup (662e0e6e82aa01fe0883e794dc9fea0407dfdadc)
+* [#15][#16] Add an example of directory metadata and static parsing (b369fdde02a5b7c25f60e86fabc248a448b68b19)
+* [#15] Add directory metadata (66dd094ffdcafb8ecced06a9ad7c578b64885689)
+* [#16] add a metadata value to force static parsing (02dc5794f9dc3efc2655d375cd2dd17c45e8cea7)
+* Fix minor regression from #15 (e179fd27d133d647d7025d82a697e6d1f202224b)
+* [#21] Add some ignored classes for mutant (0bf4a328e6aebf87ed489bcf3d6f19ea111fa95e)
+* [#21] Cover Usmu::Deployment::DirectoryDiff (d4836b1ddb950223786e35b024e2692e106a2c41)
+* [#18] Initialise logging before commander (6117299b6303b54249c06d894e074cbb437623c2)
+
 ## 0.3.2
 
 Matthew Scharley <matt.scharley@gmail.com>

data/Gemfile

@@ -1,11 +1,20 @@
 source 'https://rubygems.org'
 
+unless ENV['BUILD_PLATFORM']
+  ENV['BUILD_PLATFORM'] = case RUBY_ENGINE
+                            when 'jruby'
+                              'java'
+                            else
+                              'ruby'
+                          end
+end
+
 # Specify your gem's dependencies in usmu.gemspec
 gemspec name: 'usmu'
 
 gem 'codeclimate-test-reporter', group: :test, require: nil
 
-if RUBY_VERSION.to_f >= 2
+if RUBY_VERSION.to_f >= 2 && RUBY_VERSION.to_f < 2.2 && RUBY_ENGINE == 'ruby'
   gem 'mutant', '~> 0.7'
   gem 'mutant-rspec', '~> 0.7'
 end

data/Guardfile

@@ -4,8 +4,8 @@
 guard :rspec, cmd: 'rspec', spec_paths: ['spec'] do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/usmu/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^test/spec/support})      { 'spec' }
-  watch('test/spec/spec_helper.rb')  { 'spec' }
+  watch(%r{^spec/support})      { 'spec' }
+  watch('spec/spec_helper.rb')  { 'spec' }
 
   # Turnip features and steps
   watch(%r{^spec/acceptance/(.+)\.feature$})

data/Rakefile

@@ -8,13 +8,17 @@ def current_gems
   Dir["pkg/usmu-#{Usmu::VERSION}*.gem"].sort_by &:length
 end
 
+def platforms
+  %w(ruby java)
+end
+
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec'
 end
 
 desc 'Start an IRB session with local code available'
 task :irb do
-  exec 'bundle', 'exec', 'irb', '-I', 'lib'
+  exec *%w{bundle exec irb}
 end
 
 desc 'Run all test scripts'
@@ -26,7 +30,15 @@ task :mutant, [:target] => [:clean] do |t,args|
   if `which mutant 2>&1 > /dev/null; echo \$?`.to_i != 0
     puts 'Mutant isn\'t supported on your platform. Please run these tests on MRI <= 2.1.5.'
   else
-    sh('bundle', 'exec', 'mutant', '--include', 'lib', '--require', 'usmu', '--use', 'rspec', args[:target] || 'Usmu*')
+    sh 'bundle', 'exec', 'mutant',
+       '--include', 'lib',
+       '--require', 'usmu',
+       '--require', 'usmu/deployment',
+       '--use', 'rspec',
+       # Interfaces and documentation classes
+       '--ignore-subject', 'Usmu::Deployment::RemoteFileInterface*',
+       '--ignore-subject', 'Usmu::Plugin::CoreHooks*',
+       args[:target] || 'Usmu*'
   end
   ENV['CODECLIMATE_REPO_TOKEN'] = old unless old.nil?
 end
@@ -38,8 +50,7 @@ desc 'Clean up after tests'
 task :clean do
   [
       'tmp',
-      'test/coverage',
-      'test/site/site',
+      'test-site/site',
       current_gems,
   ].flatten.each do |f|
     rm_r f if File.exist? f
@@ -49,9 +60,16 @@ end
 namespace :gem do
   desc 'Build gems'
   task :build => [:clean] do
+    if ENV['BUNDLE_GEMFILE']
+      STDERR.puts 'This command will fail if run via bundler. If you are using RVM, please try running the following command:'
+      STDERR.puts "  NOEXEC_DISABLE=1 #{File.basename($0)} #{ARGV.join(' ')}"
+      exit 1
+    end
+
     mkdir 'pkg' unless File.exist? 'pkg'
-    Dir['*.gemspec'].each do |gemspec|
-      sh "gem build #{gemspec}"
+    platforms.each do |p|
+      ENV['BUILD_PLATFORM'] = p
+      sh *%w{gem build usmu.gemspec}
     end
     Dir['*.gem'].each do |gem|
       mv gem, "pkg/#{gem}"
@@ -61,18 +79,18 @@ namespace :gem do
   desc 'Install gem'
   task :install => ['gem:build'] do
     if RUBY_PLATFORM == 'java'
-      sh "gem install pkg/usmu-#{Usmu::VERSION}-java.gem"
+      sh *%W{gem install pkg/usmu-#{Usmu::VERSION}-java.gem}
     else
-      sh "gem install pkg/usmu-#{Usmu::VERSION}.gem"
+      sh *%W{gem install pkg/usmu-#{Usmu::VERSION}.gem}
     end
   end
 
   desc 'Deploy gems to rubygems'
   task :deploy => ['gem:build'] do
     current_gems.each do |gem|
-      sh "gem push #{gem}"
+      sh *%W{gem push #{gem}}
     end
-    sh "git tag #{Usmu::VERSION}" if File.exist? '.git'
+    sh *%W{git tag #{Usmu::VERSION}} if File.exist? '.git'
   end
 end
 

data/lib/usmu.rb

@@ -75,6 +75,7 @@ end
 %W{
   usmu/version
   usmu/configuration
+  usmu/metadata_service
   usmu/site_generator
   usmu/plugin
   usmu/plugin/core

data/lib/usmu/configuration.rb

@@ -1,4 +1,5 @@
 require 'yaml'
+require 'usmu/metadata_service'
 
 module Usmu
   # This class is used to represent a configuration file. This file should be a YAML file and called `usmu.yml`
@@ -41,6 +42,10 @@ module Usmu
       get_files source_path
     end
 
+    def source_metadata
+      @source_metadata ||= MetadataService.new(source_path)
+    end
+
     # @!attribute [r] destination_path
     # @return [String] the full path to the destination folder
     def destination_path
@@ -59,6 +64,10 @@ module Usmu
       get_files layouts_path
     end
 
+    def layouts_metadata
+      @layouts_metadata ||= MetadataService.new(layouts_path)
+    end
+
     # @!attribute [r] layouts_path
     # @return [String] the full path to the layouts folder
     def includes_path
@@ -71,6 +80,10 @@ module Usmu
       get_files includes_path
     end
 
+    def includes_metadata
+      @includes_metadata ||= MetadataService.new(includes_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
@@ -161,7 +174,7 @@ module Usmu
     def get_files(directory)
       Dir["#{directory}/**/{*,.??*}"].
           select {|f| not File.directory? f }.
-          select {|f| !f.match(/\.meta.yml$/) }.
+          select {|f| !f.match(/[\.\/]meta\.yml$/) }.
           map {|f| f[directory.length + 1, f.length] }.
           select {|f| not excluded? f }
     end

data/lib/usmu/deployment/directory_diff.rb

@@ -31,12 +31,15 @@ module Usmu
 
       private
 
+      attr_reader :configuration
+      attr_reader :remote_files
+
       def filter_files(f)
         lstat = File.stat("#{@configuration.destination_path}/#{f}")
         rstat = @remote_files.stat(f)
         lhash = File.read("#{@configuration.destination_path}/#{f}")
 
-        hash_comparison = check_hash(lhash, rstat)
+        hash_comparison = !check_hash(lhash, rstat)
         time_comparison = lstat.mtime > rstat[:mtime]
 
         time_comparison || hash_comparison
@@ -45,18 +48,18 @@ module Usmu
       def check_hash(lhash, rstat)
         if not rstat[:md5].nil?
           rhash = rstat[:md5]
-          Digest::MD5.hexdigest(lhash) != rhash
+          Digest::MD5.hexdigest(lhash).eql? rhash
         elsif not rstat[:sha1].nil?
           rhash = rstat[:sha1]
-          Digest::SHA1.hexdigest(lhash) != rhash
+          Digest::SHA1.hexdigest(lhash).eql? rhash
         else
-          false
+          true
         end
       end
 
       def local_files_list
         Dir[@configuration.destination_path + '/**/{*,.??*}'].map do |f|
-          f[(@configuration.destination_path.length + 1)..f.length]
+          f[(@configuration.destination_path.length + 1), f.length]
         end
       end
     end

data/lib/usmu/metadata_service.rb

@@ -0,0 +1,37 @@
+require 'yaml'
+require 'deep_merge'
+
+module Usmu
+  class MetadataService
+    def initialize(folder)
+      @base = folder
+    end
+
+    def metadata(file)
+      last_folder = file.rindex('/')
+      base_meta = last_folder ? metadata(file[0..(last_folder - 1)]) : {}
+
+      metafile = if File.directory?(File.join(@base, file))
+                   file + '/meta.yml'
+                 else
+                   dot_position = File.basename(file).rindex('.')
+                   if (!dot_position.nil?) && dot_position > 0
+                     file[0, file.rindex('.')] + '.meta.yml'
+                   else
+                     file + '.meta.yml'
+                   end
+                 end
+
+      metafile = File.join(@base, metafile)
+      if File.exist? metafile
+        base_meta.deep_merge! YAML.load_file(metafile)
+      else
+        base_meta
+      end
+    end
+
+    private
+
+    attr_reader :base
+  end
+end

data/lib/usmu/site_generator.rb

@@ -15,7 +15,7 @@ module Usmu
     # @!attribute [r] layouts
     # @return [Array<Usmu::Layout>] a list of layouts available in this website.
     def layouts
-      @configuration.layouts_files.map {|l| Usmu::Template::Layout.new(@configuration, l) }
+      @configuration.layouts_files.map {|l| Usmu::Template::Layout.new(@configuration, l, @configuration.layouts_metadata.metadata(l)) }
     end
 
     # @!attribute [r] renderables
@@ -29,10 +29,11 @@ module Usmu
     # Usmu::Template::StaticFile and thus be renderable, however most files will be one of the subclasses of that class.
     def renderables
       @configuration.source_files.map do |filename|
-        if Usmu::Template::Layout.is_valid_file? 'source', filename
-          Usmu::Template::Page.new(@configuration, filename)
+        metadata = @configuration.source_metadata.metadata(filename)
+        if Usmu::Template::Layout.is_valid_file?('source', filename) && (!metadata['static'])
+          Usmu::Template::Page.new(@configuration, filename, metadata)
         else
-          Usmu::Template::StaticFile.new(@configuration, filename)
+          Usmu::Template::StaticFile.new(@configuration, filename, metadata)
         end
       end
     end

data/lib/usmu/template/include.rb

@@ -34,7 +34,8 @@ module Usmu
           Dir["#{configuration.includes_path}/#{name}.*"].each do |f|
             filename = File.basename(f)
             if filename != "#{name}.meta.yml"
-              return new(configuration, f[(configuration.includes_path.length + 1)..f.length])
+              path = f[(configuration.includes_path.length + 1)..f.length]
+              return new(configuration, path, configuration.includes_metadata.metadata(path))
             end
           end
           nil

data/lib/usmu/template/layout.rb

@@ -16,11 +16,11 @@ module Usmu
 
       # @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 metadata [Hash] The metadata for the file.
       # @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)
+      def initialize(configuration, name, metadata, type = nil, content = nil)
+        super(configuration, name, metadata, type, content)
 
         if type.nil?
           type = name.split('.').last
@@ -37,16 +37,6 @@ module Usmu
         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 = Layout.find_layout(configuration, self.metadata['layout'])
 
         # Don't use the parent if it would result in weirdness
@@ -64,7 +54,7 @@ module Usmu
       # This will include any metadata from parent templates and default metadata
       def metadata
         if @parent.nil?
-          (@configuration['default meta'] || {}).dup.deep_merge!(@metadata)
+          @configuration['default meta', default: {}].dup.deep_merge!(@metadata)
         else
           @parent.metadata.deep_merge!(@metadata)
         end
@@ -252,7 +242,8 @@ module Usmu
           Dir["#{layouts_path}/#{name}.*"].each do |f|
             filename = File.basename(f)
             if filename != "#{name}.meta.yml"
-              return new(configuration, f[(layouts_path.length + 1)..f.length])
+              path = f[(layouts_path.length + 1)..f.length]
+              return new(configuration, path, configuration.layouts_metadata.metadata(path))
             end
           end
         else

data/lib/usmu/template/page.rb

@@ -7,11 +7,11 @@ module Usmu
 
       # @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 metadata [Hash] The metadata for the file.
       # @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, type, content, metadata)
+      def initialize(configuration, name, metadata, type = nil, content = nil)
+        super(configuration, name, metadata, type, content)
 
         current_parent = parent
         until current_parent.nil?

data/lib/usmu/template/static_file.rb

@@ -11,16 +11,17 @@ module Usmu
 
       # @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 metadata [Hash] The metadata for the file.
       # @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)
+      def initialize(configuration, name, metadata, type = nil, content = nil)
         @log = Logging.logger[self]
         @log.debug("Creating <##{self.class.name} @name=\"#{name}\">")
 
         @configuration = configuration
         @name = name
+        @metadata = metadata
         @type = type
         @content = content
       end

data/lib/usmu/ui/console.rb

@@ -20,6 +20,7 @@ module Usmu
       # @param [Array<String>] args Command line arguments, ie. ARGV.
       def initialize(args)
         @log = Logging.logger[self]
+        initialize_logging args
         @commander = initialize_commander(args)
 
         Usmu.plugins.load_plugins
@@ -49,6 +50,30 @@ module Usmu
 
       private
 
+      def initialize_logging(args)
+        i = 0
+        while i < args.length
+          case args[i]
+            when '-v', '--verbose'
+              args.delete_at i
+              Usmu.verbose_logging
+            when '-q', '--quiet'
+              args.delete_at i
+              Usmu.quiet_logging
+            when '--log'
+              if args.length > i + 1
+                args.delete_at i
+                path = args.delete_at i
+                Usmu.add_file_logger path
+              else
+                i += 1
+              end
+            else
+              i += 1
+          end
+        end
+      end
+
       # Helper function to setup a Commander runner
       # @return [Commander::Runner]
       def initialize_commander(args)
@@ -58,10 +83,11 @@ module Usmu
         commander.program :description, 'Static site generator powered by Tilt'
         commander.program :int_message, 'Interrupt received, closing...'
 
-        commander.global_option('-v', '--verbose') { Usmu.verbose_logging }
-        commander.global_option('-q', '--quiet') { Usmu.quiet_logging }
-        commander.global_option('--log STRING', String) {|log| Usmu.add_file_logger(log) }
         commander.global_option('--config STRING', String, &method(:load_configuration))
+        # Logging options are manually processed in #initialize_logging, but included here for user documentations sake
+        commander.global_option('-v', '--verbose')
+        commander.global_option('-q', '--quiet')
+        commander.global_option('--log STRING', String)
 
         commander
       end