usmu 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fc86dae15be6aceae0a11ed6b8d31b381eb2fda
-  data.tar.gz: e86a3100c2b95c4f095597c12b302eee60e61352
+  metadata.gz: 82edd4386ce8ad7e313db42fcb53ae4b908f8988
+  data.tar.gz: bf0bbc5db654e595fccfaa5d65965976d2d2b75d
 SHA512:
-  metadata.gz: f198fb4e39bf471a56324c001216e2eee1041b9c04ec8f842d2c62c36dc0524f1e15598ae097aaf6af395b2ca8f249030f7748d1bd9636351f2c4d2afe86fade
-  data.tar.gz: bfee2b4b896e7d1dd990beb33eb0c76c9e80647f29e4cb6cbc9afee036a6aff166b7a1ce3f57e83d4c304a0086fec0c9cad2b294fd29fb9423ca776170be8279
+  metadata.gz: 19a6e9d124cefab1e4068b5c29da0eb1656cf7e10bf844e5b7ae29fc03d7e39966e5d11785a13fdf28eeb8e6d7d14f5acf41c37cda6cf51dbdc5d9b99df24860
+  data.tar.gz: 181da46641fa0d63e0359f069bba71d2deca24fac77fb03ee801be16bebc769361d3c5fd4584023f039a38616b24c52d32a198f52fc4f5e515eac0823cc6f187

data/.gitignore

@@ -3,7 +3,6 @@
 /.sass-cache
 /Gemfile*.lock
 /_yardoc/
-/test/coverage/
 /doc/
 /pkg/
 /spec/reports/
@@ -16,4 +15,4 @@
 mkmf.log
 
 # Generated test site
-/test/site/site
+/test-site/site

data/.travis.yml

@@ -32,3 +32,6 @@ matrix:
     - rvm: rbx-2.2
     - rvm: rbx-2.3
     - rvm: rbx-2.4
+addons:
+  code_climate:
+    repo_token: 5ac0735331c1749a461eae94f89cd2011cc001979f9941d7241f97caeff7bde1

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Usmu Change Log
 
+## 0.3.2
+
+Matthew Scharley <matt.scharley@gmail.com>
+
+* Add Code Climate (740713e6fb181036fa0e071149b0f85fbb44e520)
+* Use Code Climate's coverage tracking (536365b3c821d7ab145fd9e6241a1cd5302ca986)
+* First pass of a directory diff for deployment plugins (47f0dccbb3b330dcf8821248d4cd964b0564e50c)
+* Add some more tests for coverage of DirectoryDiff (8ae3a9311c395a3f09f3cc4d0e6753a24a6b9f99)
+* Cleanup code complexity (2d4cbfc9ae78cda8a0607c3998bda016b65f041b)
+* Try to cleanup Layout a little (a2c6ce32fa16075ba332932b9a542ff1c8a35732)
+* Install mutant (6f170c6a3181c9a071c930a949058e3d6e760b6b)
+* Move spec folder into root directory (571451ddd9403ede4f097072facf443178428953)
+* Finalise mutant configuration (2e6fd8239112ca7f3cb9ab75424b82606835b944)
+* Don't allow reporting code climate for mutant tests (cca22b243a052165173e04dde8294864aa639c0c)
+* Add a guard to only run on MRI (1035ea042f12dfe7bd9ce7d632245b7c59e48d3f)
+* Stop mutant attempting to run where it won't (38aa6c042c9d8bb3eacd75e7b8a937c538ca729f)
+* Don't run mutant on CI (b5d6d9f6f50e9331a0ec07d50596d605829d0d8e)
+* Don't mask errors from mutant (6257b3b02749ba07f697014562f2768198cd12c0)
+* Convert existing coverage for Configuration to proper unit tests (536df7c3a17268920bbb7bbc4de74f38d224755f)
+* 100% mutant coverage for Configuration (6d616736dd01971c842f870164b1b0612ebd80aa)
+
 ## 0.3.1
 
 Matthew Scharley <matt.scharley@gmail.com>

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # 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
+  gem 'mutant', '~> 0.7'
+  gem 'mutant-rspec', '~> 0.7'
+end

data/Guardfile

@@ -1,13 +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' }
+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' }
 
   # 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' }
+  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

@@ -1,4 +1,8 @@
-# usmu [![Build Status](https://travis-ci.org/usmu/usmu.svg?branch=master)](https://travis-ci.org/usmu/usmu) [![Dependency Status](https://gemnasium.com/usmu/usmu.svg)](https://gemnasium.com/usmu/usmu)
+# usmu
+
+[![Build Status](https://travis-ci.org/usmu/usmu.svg?branch=master)](https://travis-ci.org/usmu/usmu)
+[![Dependency Status](https://gemnasium.com/usmu/usmu.svg)](https://gemnasium.com/usmu/usmu)
+[![Code Climate](https://codeclimate.com/github/usmu/usmu/badges/gpa.svg)](https://codeclimate.com/github/usmu/usmu)
 
 **Source:** [https://github.com/usmu/usmu](https://github.com/usmu/usmu)  
 **Author:** Matthew Scharley  

data/Rakefile

@@ -5,11 +5,11 @@ require 'rspec/core/rake_task'
 require 'usmu/version'
 
 def current_gems
-  Dir["pkg/usmu-#{Usmu::VERSION}*.gem"]
+  Dir["pkg/usmu-#{Usmu::VERSION}*.gem"].sort_by &:length
 end
 
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.pattern = 'test/spec'
+  t.pattern = 'spec'
 end
 
 desc 'Start an IRB session with local code available'
@@ -18,10 +18,21 @@ task :irb do
 end
 
 desc 'Run all test scripts'
-task :test => [:clean, :spec]
+task :test => [:clean, :spec, :mutant]
+
+desc 'Run mutation tests'
+task :mutant, [:target] => [:clean] do |t,args|
+  old = ENV.delete('CODECLIMATE_REPO_TOKEN')
+  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*')
+  end
+  ENV['CODECLIMATE_REPO_TOKEN'] = old unless old.nil?
+end
 
 desc 'Run CI test suite'
-task :ci => [:test]
+task :ci => [:clean, :spec]
 
 desc 'Clean up after tests'
 task :clean do
@@ -68,7 +79,7 @@ end
 # (mostly) borrowed from: https://gist.github.com/mcansky/802396
 desc 'generate changelog with nice clean output'
 task :changelog, :since_c, :until_c do |t,args|
-  since_c = args[:since_c] || `git tag | head -1`.chomp
+  since_c = args[:since_c] || `git tag | egrep '^[0-9]+\\.[0-9]+\\.[0-9]+\$' | sort -Vr | head -n 1`.chomp
   until_c = args[:until_c]
   cmd=`git log --pretty='format:%ci::::%an <%ae>::::%s::::%H' #{since_c}..#{until_c}`
 

data/lib/usmu.rb

@@ -16,7 +16,6 @@ Logging.color_scheme(
 module Usmu
   @log = Logging.logger['Usmu']
   @log.level = :all
-  @log.additive = false
   @log.appenders = Logging.appenders.stdout(
       'usmu-stdout',
       :level => :info,
@@ -26,6 +25,9 @@ module Usmu
       ),
   )
 
+  # Globbing flags. Correct across 1.9.3 and 2.0+, enabling as many features as available
+  FILE_GLOB_FLAGS = defined?(File::FNM_EXTGLOB) ? File::FNM_EXTGLOB | File::FNM_PATHNAME : File::FNM_PATHNAME
+
   # Enable logging of all events to the console
   #
   # @return [void]

data/lib/usmu/configuration.rb

@@ -17,21 +17,22 @@ module Usmu
     #
     # @return [Usmu::Configuration]
     def self.from_file(filename)
+      raise ArgumentError, "File not found: #{filename}" if filename.nil? || (not File.exist? filename)
       @log.debug("Loading configuration from #{filename}")
-      from_hash(YAML.load_file(filename), filename)
+      new(YAML.load_file(filename), filename)
     end
 
     # Load a configuration from a hash.
     #
     # @return [Usmu::Configuration]
     def self.from_hash(hash, config_path = nil)
-      self.new(hash, config_path)
+      new(hash, config_path)
     end
 
     # @!attribute [r] source_path
     # @return [String] the full path to the source folder
     def source_path
-      get_path @config['source'] || 'src'
+      get_path self['source'] || 'src'
     end
 
     # @!attribute [r] source_files
@@ -43,13 +44,13 @@ module Usmu
     # @!attribute [r] destination_path
     # @return [String] the full path to the destination folder
     def destination_path
-      get_path @config['destination'] || 'site'
+      get_path self['destination'] || 'site'
     end
 
     # @!attribute [r] layouts_path
     # @return [String] the full path to the layouts folder
     def layouts_path
-      get_path @config['layouts'] || 'layouts'
+      get_path self['layouts'] || 'layouts'
     end
 
     # @!attribute [r] layouts_files
@@ -61,7 +62,7 @@ module Usmu
     # @!attribute [r] layouts_path
     # @return [String] the full path to the layouts folder
     def includes_path
-      get_path @config['includes'] || 'includes'
+      get_path self['includes'] || 'includes'
     end
 
     # @!attribute [r] layouts_files
@@ -86,7 +87,7 @@ module Usmu
     #   Returns a value from the hash loaded from YAML. The type of value will ultimately depend on the configuration
     #   file and the indices provided.
     def [](*indices)
-      if indices[-1].class.name == 'Hash'
+      if indices.last.instance_of? Hash
         opts = indices.pop
       else
         opts = {}
@@ -105,8 +106,18 @@ module Usmu
       value
     end
 
+    # Returns an array of exclusions
+    #
+    # @return [Array]
+    def exclude
+      self['exclude'] || []
+    end
+
     private
 
+    attr_reader :log
+    attr_reader :config
+
     # This class has a private constructor.
     #
     # @see Usmu::Configuration.from_file
@@ -115,7 +126,9 @@ module Usmu
       @log = Logging.logger[self]
       @config = hash
       @config_file = config_path
-      @config_dir = config_path ? File.dirname(config_path) : nil
+      @config_dir = if config_path
+                      File.dirname(config_path)
+                    end
     end
 
     # Helper function to transform a relative path in the configuration file to a relative path from the current
@@ -134,10 +147,9 @@ module Usmu
     #
     # @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)
+      exclude.each do |f|
+        f += '**/*' if f.end_with? '/'
+        return true if File.fnmatch(f, filename, FILE_GLOB_FLAGS)
       end
       false
     end
@@ -150,7 +162,7 @@ module Usmu
       Dir["#{directory}/**/{*,.??*}"].
           select {|f| not File.directory? f }.
           select {|f| !f.match(/\.meta.yml$/) }.
-          map {|f| f[(directory.length + 1)..f.length] }.
+          map {|f| f[directory.length + 1, f.length] }.
           select {|f| not excluded? f }
     end
   end

data/lib/usmu/deployment.rb

@@ -0,0 +1,12 @@
+
+module Usmu
+  # This module is a namespace for all common deployment related classes. This includes some helpers for deployment
+  # plugins such as the S3 plugin.
+  module Deployment
+  end
+end
+
+%w{
+  usmu/deployment/directory_diff
+  usmu/deployment/remote_file_interface
+}.each {|f| require f }

data/lib/usmu/deployment/directory_diff.rb

@@ -0,0 +1,64 @@
+require 'digest'
+
+module Usmu
+  module Deployment
+    class DirectoryDiff
+      # @param [Usmu::Configuration] configuration
+      # @param [Usmu::Deployment::RemoteFileInterface] remote_files
+      def initialize(configuration, remote_files)
+        @configuration = configuration
+        @remote_files = remote_files
+      end
+
+      # @return [Hash]
+      #   A hash of arrays of filenames:
+      #
+      #   * `:local` - local-only files
+      #   * `:remote` - remote-only files
+      #   * `:updated` - files that were updated
+      def get_diffs
+        local_files = local_files_list
+        remote_files = @remote_files.files_list
+
+        updated_files = (local_files & remote_files).select &method(:filter_files)
+
+        {
+            :local => local_files - remote_files,
+            :remote => remote_files - local_files,
+            :updated => updated_files,
+        }
+      end
+
+      private
+
+      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)
+        time_comparison = lstat.mtime > rstat[:mtime]
+
+        time_comparison || hash_comparison
+      end
+
+      def check_hash(lhash, rstat)
+        if not rstat[:md5].nil?
+          rhash = rstat[:md5]
+          Digest::MD5.hexdigest(lhash) != rhash
+        elsif not rstat[:sha1].nil?
+          rhash = rstat[:sha1]
+          Digest::SHA1.hexdigest(lhash) != rhash
+        else
+          false
+        end
+      end
+
+      def local_files_list
+        Dir[@configuration.destination_path + '/**/{*,.??*}'].map do |f|
+          f[(@configuration.destination_path.length + 1)..f.length]
+        end
+      end
+    end
+  end
+end

data/lib/usmu/deployment/remote_file_interface.rb

@@ -0,0 +1,25 @@
+
+module Usmu
+  module Deployment
+    module RemoteFileInterface
+      # Returns a complete list of files on the remote server.
+      #
+      # @return [Array<String>] An array of filenames including paths.
+      def files_list
+        raise NotImplementedError
+      end
+
+      # Returns a hash of information about the named file, including at a minimum the following:
+      #
+      # * `:mtime` - DateTime representing when the file was last modified.
+      # * One of `:md5` or `:sha1` - A hash of the remote file.
+      #
+      # @param [String] filename The full path and filename as returned from #files_list.
+      #
+      # @return [Hash]
+      def stat(filename)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/usmu/plugin.rb

@@ -68,11 +68,15 @@ module Usmu
 
       unless @loaded.include? load_path
         @loaded << load_path
-        klass = load_path.split('/').map {|s| s.split('_').map(&:capitalize).join }.join('::')
+        klass = path_to_class(load_path)
         @log.debug("Loading plugin #{klass} from '#{load_path}'")
         plugins.push plugin_get(klass)
       end
       nil
     end
+
+    def path_to_class(load_path)
+      load_path.split('/').map { |s| s.split('_').map(&:capitalize).join }.join('::')
+    end
   end
 end

data/lib/usmu/template/layout.rb

@@ -7,6 +7,9 @@ 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
+      @layout_history = Hash.new({})
+      @log = Logging.logger[self]
+
       # @!attribute [r] type
       # @return [String] the type of file this is. This is used to determine which template engine to use.
       attr_reader :type
@@ -44,7 +47,6 @@ module Usmu
         end
         @metadata = metadata
 
-        @parent = nil
         @parent = Layout.find_layout(configuration, self.metadata['layout'])
 
         # Don't use the parent if it would result in weirdness
@@ -139,31 +141,18 @@ module Usmu
       def self.find_layout(configuration, name)
         return nil if name.nil?
 
-        @layout_history = @layout_history || {}
-        @layout_history[configuration] = @layout_history[configuration] || {}
         if @layout_history[configuration][name]
-          Logging.logger[self].debug(
+          @log.debug(
               'Layout loop detected. Current loaded layouts: ' +
               @layout_history[configuration].inspect
           )
           return nil
         else
-          Logging.logger[self].debug("Loading layout '#{name}'")
+          @log.debug("Loading layout '#{name}'")
           @layout_history[configuration][name] = true
         end
 
-        ret = nil
-        if name === 'none' || name.nil?
-        elsif name.class.name == 'String'
-          Dir["#{configuration.layouts_path}/#{name}.*"].each do |f|
-            filename = File.basename(f)
-            if filename != "#{name}.meta.yml"
-              ret = new(configuration, f[(configuration.layouts_path.length + 1)..f.length])
-            end
-          end
-        else
-          ret = name
-        end
+        ret = search_layout(configuration, name)
 
         @layout_history[configuration][name] = nil
         return ret
@@ -252,6 +241,24 @@ module Usmu
       def get_variables(variables)
         {'site' => @configuration}.deep_merge!(metadata).deep_merge!(variables)
       end
+
+      # @see Usmu::Template::Layout#find_layout
+      # @return [Usmu::Template::Layout]
+      def self.search_layout(configuration, name)
+        if name === 'none' || name.nil?
+          return nil
+        elsif name.class.name == 'String'
+          layouts_path = configuration.layouts_path
+          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])
+            end
+          end
+        else
+          return name
+        end
+      end
     end
   end
 end