usmu 1.0.0-java → 1.0.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 076f6e4f586e0257b024ec579888017278a53b37
-  data.tar.gz: e7ce74410b8b2f7a4f0445dc1fc9564340344504
+  metadata.gz: edd7433ee4c0dbc62aa99b6fea962c901e6bbf5f
+  data.tar.gz: fc146facac5a999db5b93052c2a673473b71fc8c
 SHA512:
-  metadata.gz: 9dccb1a78e6e9fd7b02d2be250becddf37894f59853a694e22235556ebd7391809941689e175fac09cf3a48e1847ac92b6308b240a17747e6fd773b7132f8f0e
-  data.tar.gz: 7ab64019c566d4411ad8f4beac28384e5580841dde0c9a2900908aff82f2d4579ec6a6435bad155331f352121846bf289f5edccc5084e61a1687e553ee84169a
+  metadata.gz: b32249f6dc8882c6b80222e27133bff664a2bb9abef545c958f5bf2634cb657289fc629ed167a645ec7b31a0233a3d441441f61c31f687231811d784fd48531f
+  data.tar.gz: c94c2d0e01c1abb342c798ebc7a02f835153e9fc2843a2a28bde29b9ae8c6227b367d37df96b569eff7d5331f3fb84ef568a9e5ed33692cee08ee5a5154ebaa0

data/CHANGELOG.md

@@ -6,10 +6,14 @@ Matthew Scharley <matt.scharley@gmail.com>
 
 * Minor refactor of /spec (d353c8a1f8914dc9fb554770479092cfc1e526bc)
 * Small update to the init site (d86e9a205a3a2f1cc76dec7e66f0540edc9e13c1)
-* [#29] Generalise Configuration#[] into Helpers::Indexer and add to Layout (474b5d778f841595602a4ec7913a646ff5e90106)
-* [#27] Add permalinks (ce190c0d33e84bf38b26cc134fe96bb9a3bb3f22)
-* [#19] Basic functional collection support for paging (de2fa4194fe9db955e09a302a1b87816557e8f3e)
-* [#19] Add enumeration of collections (e6923cf10426e62bc5f35c3649303a1ae65466fd)
+* [\[\#29\]][GH-29] Generalise Configuration\#\[\] into Helpers::Indexer and add to Layout (474b5d778f841595602a4ec7913a646ff5e90106)
+* [\[\#27\]][GH-27] Add permalinks (ce190c0d33e84bf38b26cc134fe96bb9a3bb3f22)
+* [\[\#19\]][GH-19] Basic functional collection support for paging (de2fa4194fe9db955e09a302a1b87816557e8f3e)
+* [\[\#19\]][GH-19] Add enumeration of collections (e6923cf10426e62bc5f35c3649303a1ae65466fd)
+
+  [GH-19]:  https://github.com/usmu/usmu/issues/19
+  [GH-27]:  https://github.com/usmu/usmu/issues/27
+  [GH-29]:  https://github.com/usmu/usmu/issues/29
 
 ## 0.4.0
 
@@ -17,7 +21,9 @@ Matthew Scharley <matt.scharley@gmail.com>
 
 * Bump to 0.4.0.dev for further dev (32596fe063dfb0452098b0bcac7d97f57ee772a5)
 * Ensure that loggers have the right functions available (df1c685c9ee7f3e4070351700d0ec28d999bc345)
-* [#25] Include a Rack app for viewing site dynamically (964486386bfa6325f191a44be0eb301ce5d200be)
+* [\[\#25\]][GH-25] Include a Rack app for viewing site dynamically (964486386bfa6325f191a44be0eb301ce5d200be)
+
+  [GH-25]:  https://github.com/usmu/usmu/issues/25
 
 ## 0.3.4
 
@@ -43,6 +49,10 @@ Matthew Scharley <matt.scharley@gmail.com>
 * [\[#21\]][GH-21] Cover Usmu::Deployment::DirectoryDiff (d4836b1ddb950223786e35b024e2692e106a2c41)
 * [\[#18\]][GH-16] Initialise logging before commander (6117299b6303b54249c06d894e074cbb437623c2)
 
+  [GH-15]: https://github.com/usmu/usmu/issues/15
+  [GH-16]: https://github.com/usmu/usmu/issues/16
+  [GH-21]: https://github.com/usmu/usmu/issues/21
+
 ## 0.3.2
 
 Matthew Scharley <matt.scharley@gmail.com>
@@ -89,6 +99,11 @@ Matthew Scharley <matt.scharley@gmail.com>
 * [\[\#13\]][GH-13] Add page metadata to parent layouts (c2da294e1f19e6404df178ee650c3818cc0f3846)
 * Add a Sass partials exclude to default init site (4f70d5b1b5958b6c56338b8d077711c780c85763)
 
+  [GH-12]: https://github.com/usmu/usmu/issues/12
+  [GH-13]: https://github.com/usmu/usmu/issues/13
+  [GH-14]: https://github.com/usmu/usmu/issues/14
+  [GH-17]: https://github.com/usmu/usmu/issues/17
+
 ## 0.2.2
 
 Matthew Scharley <matt.scharley@gmail.com>
@@ -125,6 +140,9 @@ Matthew Scharley <matt.scharley@gmail.com>
 * Remove RBX 2.3 again. (b8675c07d0fe066c466144c27e690f1863a88888)
 * Release 0.2.2 (986f611b167a0503108d41ac0a115e38d6aac2f9)
 
+  [GH-8]:  https://github.com/usmu/usmu/issues/8
+  [GH-9]:  https://github.com/usmu/usmu/issues/9
+
 ## 0.2.1
 
 Matthew Scharley <matt.scharley@gmail.com>
@@ -160,6 +178,9 @@ Matthew Scharley <matt.scharley@gmail.com>
 * Re-enable 1.9.3 CI and add some compat notes to the readme (cf34053aaaf6a85752ec8be70f7c9969a89990d9)
 * Bump to 0.2.0 release (7e7dde04c180b5ae63268db647ba45ef63a6b3f3)
 
+  [GH-5]:  https://github.com/usmu/usmu/issues/5
+  [GH-7]:  https://github.com/usmu/usmu/issues/7
+
 ## 0.1.0
 
 Matthew Scharley <matt.scharley@gmail.com>
@@ -205,16 +226,3 @@ Matthew Scharley <matt.scharley@gmail.com>
 * Small stylistic change (ae008aa5492b2463774e4e4659d90666059b45e0)
 * Add new custom rake tasks for building gems and fix a few small issues with the specs (5b1a4241cd9f31f39179ffaad49f7155617c0e6f)
 * Bump to full 0.1.0 release (fb91c2b54f79eeaeb615f98f874c990e4cdddfd3)
-
-  [GH-5]:  https://github.com/usmu/usmu/issues/5
-  [GH-7]:  https://github.com/usmu/usmu/issues/7
-  [GH-8]:  https://github.com/usmu/usmu/issues/8
-  [GH-9]:  https://github.com/usmu/usmu/issues/9
-  [GH-12]: https://github.com/usmu/usmu/issues/12
-  [GH-13]: https://github.com/usmu/usmu/issues/13
-  [GH-14]: https://github.com/usmu/usmu/issues/14
-  [GH-15]: https://github.com/usmu/usmu/issues/15
-  [GH-16]: https://github.com/usmu/usmu/issues/16
-  [GH-17]: https://github.com/usmu/usmu/issues/17
-  [GH-18]: https://github.com/usmu/usmu/issues/18
-  [GH-21]: https://github.com/usmu/usmu/issues/21

data/Gemfile

@@ -15,6 +15,6 @@ gemspec name: 'usmu'
 gem 'codeclimate-test-reporter', group: :test, require: nil
 
 if RUBY_VERSION.to_f >= 2 && RUBY_VERSION.to_f < 2.2 && RUBY_ENGINE == 'ruby'
-  gem 'mutant', '~> 0.7'
-  gem 'mutant-rspec', '~> 0.7'
+  gem 'mutant', '~> 0.7', :group => :development
+  gem 'mutant-rspec', '~> 0.7', :group => :development
 end

data/lib/usmu/configuration.rb

@@ -47,6 +47,8 @@ module Usmu
       get_files source_path
     end
 
+    # @!attribute [r] source_metadata
+    # @return [MetadataService] a metadata service for retrieving metadata about pages in #source_path
     def source_metadata
       @source_metadata ||= MetadataService.new(source_path)
     end
@@ -85,6 +87,8 @@ module Usmu
       get_files includes_path
     end
 
+    # @!attribute [r] includes_metadata
+    # @return [MetadataService] a metadata service for retrieving metadata about includes
     def includes_metadata
       @includes_metadata ||= MetadataService.new(includes_path)
     end

data/lib/usmu/site_generator.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'usmu/collections'
 require 'usmu/configuration'
 require 'usmu/template/page'
 require 'usmu/template/static_file'
@@ -15,7 +16,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_metadata.metadata(l)) }
+      @configuration.layouts_files.map {|l| Template::Layout.new(@configuration, l, @configuration.layouts_metadata.metadata(l)) }
     end
 
     # @!attribute [r] renderables
@@ -30,25 +31,26 @@ module Usmu
     def renderables
       @configuration.source_files.map do |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)
+        if Template::Layout.is_valid_file?('source', filename) && (!metadata['static'])
+          Template::Page.new(@configuration, filename, metadata)
         else
-          Usmu::Template::StaticFile.new(@configuration, filename, metadata)
+          Template::StaticFile.new(@configuration, filename, metadata)
         end
       end
     end
 
     # @!attribute [r] pages
-    # @return [Array<Usmu::Template::Page>] a list of pages from the source folder. This is any file in the source
-    #   folder which is not static.
+    # @return [Array<Usmu::Template::Page>]
+    #   a list of pages from the source folder. This is any file in the source folder which is not static.
     def pages
-      renderables.select {|r| r.class.name != 'Usmu::Template::StaticFile'}
+      renderables.select {|r| r.class <= Template::Layout }
     end
 
     # @!attribute [r] files
-    # @return [Array<Usmu::Template::StaticFile>] a list of static files from the source folder.
+    # @return [Array<Usmu::Template::StaticFile>]
+    #   a list of static files from the source folder.
     def files
-      renderables.select {|r| r.class.name == 'Usmu::Template::StaticFile'}
+      renderables - pages
     end
 
     # Generate the website according to the configuration given.
@@ -63,12 +65,17 @@ module Usmu
       nil
     end
 
+    # Returns an interface for interacting with collections defined in this site.
+    #
+    # @return [Usmu::Collections]
     def collections
       @collections ||= Collections.new(self)
     end
 
+    # Refresh information about this site.
     def refresh
       collections.refresh
+      nil
     end
 
     private
@@ -88,7 +95,8 @@ module Usmu
       end
 
       File.write file, page.render
-      FileUtils.touch file, :mtime => File.stat(page.input_path).mtime
+      FileUtils.touch file, mtime: File.stat(page.input_path).mtime
+      nil
     end
   end
 end

data/lib/usmu/version.rb

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

data/spec/mock/usmu/mock_metadata_configuration.rb

@@ -0,0 +1,12 @@
+
+module Usmu
+  class MockMetadataConfiguration
+    def initialize(hash)
+      @config = hash
+    end
+
+    def metadata(filename)
+      @config[filename] || {}
+    end
+  end
+end

data/spec/usmu/configuration_spec.rb

@@ -167,6 +167,14 @@ RSpec.describe Usmu::Configuration do
     end
   end
 
+  context '#generator' do
+    it 'should return a new SiteGenerator' do
+      sg = {fake: 'success'}
+      expect(Usmu::SiteGenerator).to receive(:new).with(empty_configuration).and_return(sg)
+      expect(empty_configuration.generator).to eq(sg)
+    end
+  end
+
   context '#[]' do
     it 'should remember arbitrary configuration' do
       configuration = Usmu::Configuration.from_hash({:test => 'foo'})

data/spec/usmu/site_generator_spec.rb

@@ -1,35 +1,146 @@
 require 'usmu/site_generator'
+require 'usmu/mock_metadata_configuration'
+require 'ostruct'
 
 RSpec.describe Usmu::SiteGenerator do
-  let(:configuration) { Usmu::Configuration.from_file('test-site/usmu.yml') }
+  let(:meta_mock) {
+    Usmu::MockMetadataConfiguration.new(
+        {
+            'assets/external.scss' => { 'static' => true }
+        }
+    )
+  }
+  let(:configuration) { Usmu::Configuration.from_hash({}) }
   let(:generator) { Usmu::SiteGenerator.new(configuration) }
 
-  it 'should have layouts' do
-    expect(generator.respond_to? :layouts).to eq(true)
-    expect(generator.layouts.map {|l| l.name}.sort).to eq(%w{embedded.slim html.slim post.slim})
+  before do
+    allow(configuration).to receive(:layouts_metadata).and_return(meta_mock)
+    allow(configuration).to receive(:source_metadata).and_return(meta_mock)
+
+    allow(Dir).to receive(:[]).with('src/**/{*,.??*}').and_return(%w{src/.dotfiletest.txt src/assets src/assets/external.scss src/css src/css/app.scss src/index.md src/posts src/posts/second-post.md src/posts/test-post.md src/robots.txt})
+    allow(Dir).to receive(:[]).with('layouts/**/{*,.??*}').and_return(%w{layouts/embedded.slim layouts/html.slim layouts/post.slim})
+
+    allow(File).to receive(:directory?).and_return(false)
+    %w{src/assets src/css src/posts}.each do |f|
+      allow(File).to receive(:directory?).with(f).and_return(true)
+    end
+
+    allow(Usmu::Template::StaticFile).to receive(:new) {|config, filename, metadata| instance_double('Usmu::Template::StaticFile', class: Usmu::Template::StaticFile, name: filename) if config == configuration && metadata == meta_mock.metadata(filename) }
+    allow(Usmu::Template::Page).to receive(:new) {|config, filename, metadata| instance_double('Usmu::Template::Page', class: Usmu::Template::Page, name: filename) if config == configuration && metadata == meta_mock.metadata(filename) }
+    allow(Usmu::Template::Layout).to receive(:new) {|config, filename, metadata| instance_double('Usmu::Template::Layout', class: Usmu::Template::Layout, name: filename) if config == configuration && metadata == meta_mock.metadata(filename) }
   end
 
-  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{.dotfiletest.txt archive.slim assets/external.scss css/app.scss default.md embedded.md index.md posts/second-post.md posts/test-post.md robots.txt})
+  context '#layouts' do
+    it 'should list layouts' do
+      expect(meta_mock).to receive(:metadata).at_least(1).times.with('embedded.slim').and_return({})
+      expect(meta_mock).to receive(:metadata).at_least(1).times.with('html.slim').and_return({})
+      expect(meta_mock).to receive(:metadata).at_least(1).times.with('post.slim').and_return({})
+      expect(generator.layouts.map {|l| l.name}.sort).to eq(%w{embedded.slim html.slim post.slim})
+    end
   end
 
-  it 'should have pages' do
-    expect(generator.respond_to? :pages).to eq(true)
-    expect(generator.pages.map {|p| p.name}.sort).to eq(%w{archive.slim css/app.scss default.md embedded.md index.md posts/second-post.md posts/test-post.md})
+  context '#renderables' do
+    before do
+      allow(Usmu::Template::Layout).to receive(:is_valid_file?).with('source', '.dotfiletest.txt').and_return(false)
+      allow(Usmu::Template::Layout).to receive(:is_valid_file?).with('source', 'assets/external.scss').and_return(true)
+      allow(Usmu::Template::Layout).to receive(:is_valid_file?).with('source', 'css/app.scss').and_return(true)
+      allow(Usmu::Template::Layout).to receive(:is_valid_file?).with('source', 'index.md').and_return(true)
+      allow(Usmu::Template::Layout).to receive(:is_valid_file?).with('source', 'posts/second-post.md').and_return(true)
+      allow(Usmu::Template::Layout).to receive(:is_valid_file?).with('source', 'posts/test-post.md').and_return(true)
+      allow(Usmu::Template::Layout).to receive(:is_valid_file?).with('source', 'robots.txt').and_return(false)
+    end
+
+    it 'should create static files as StaticFile and honour the "static" metadata attribute' do
+      expect(generator.renderables.select {|r| r.class == Usmu::Template::StaticFile }.map {|r| r.name}.sort).to eq(%w{.dotfiletest.txt assets/external.scss robots.txt})
+    end
+
+    it 'should create static files as StaticFile and honour the "static" metadata attribute' do
+      expect(generator.renderables.select {|r| r.class == Usmu::Template::Page }.map {|r| r.name}.sort).to eq(%w{css/app.scss index.md posts/second-post.md posts/test-post.md})
+    end
+
+    it 'should not list directories' do
+      expect(generator.files.select {|f| f.name == 'posts'}.length).to eq(0)
+    end
+  end
+
+  context '#pages' do
+    it 'should list pages' do
+      expect(generator).to receive(:renderables).and_return(
+                               [
+                                   instance_double('Usmu::Template::StaticFile', class: Usmu::Template::StaticFile, name: 'robots.txt'),
+                                   instance_double('Usmu::Template::Layout', class: Usmu::Template::Layout, name: 'layout.slim'),
+                                   instance_double('Usmu::Template::Page', class: Usmu::Template::Page, name: 'page.md'),
+                               ]
+                           )
+      expect(generator.pages.map {|p| p.name}.sort).to eq(%w{layout.slim page.md})
+    end
   end
 
-  it 'should have files' do
-    expect(generator.respond_to? :files).to eq(true)
-    expect(generator.files.map {|f| f.name}.sort).to eq(%w{.dotfiletest.txt assets/external.scss robots.txt})
+  context '#files' do
+    it 'should list static files' do
+      expect(generator).to receive(:renderables).at_least(1).times.and_return(
+                               [
+                                   instance_double('Usmu::Template::StaticFile', class: Usmu::Template::StaticFile, name: 'robots.txt'),
+                                   instance_double('Usmu::Template::Layout', class: Usmu::Template::Layout, name: 'layout.slim'),
+                                   instance_double('Usmu::Template::Page', class: Usmu::Template::Page, name: 'page.md'),
+                               ]
+                           )
+      expect(generator.files.map {|f| f.name}.sort).to eq(%w{robots.txt})
+    end
   end
 
-  it 'should not list directories' do
-    expect(generator.respond_to? :files).to eq(true)
-    expect(generator.files.select {|f| f.name == 'posts'}.length).to eq(0)
+  context '#generate' do
+    it 'should call #generate_page for each renderable' do
+      expect(generator).to receive(:renderables).and_return([{test: 'success'}])
+      expect(generator).to receive(:generate_page).with({test: 'success'})
+      expect(generator.generate).to eq(nil)
+      expect(@log_output.readline).to eq("   INFO  Usmu::SiteGenerator : Source: src\n")
+      expect(@log_output.readline).to eq("   INFO  Usmu::SiteGenerator : Destination: site\n")
+      expect(@log_output.readline).to eq("   INFO  Usmu::SiteGenerator : \n")
+    end
   end
 
-  it 'should be able to generate a site' do
-    expect(generator.respond_to? :generate).to eq(true)
+  context '#collections' do
+    it 'should return a Collections interface' do
+      expect(Usmu::Collections).to receive(:new).with(generator).and_return({test: 'success'})
+      expect(generator.collections).to eq({test: 'success'})
+    end
+  end
+
+  context '#refresh' do
+    it 'refresh collections' do
+      expect(generator.collections).to receive(:refresh).and_return(true)
+      expect(generator.refresh).to eq(nil)
+    end
+  end
+
+  context '#generate_page' do
+    before do
+      allow(File).to receive(:directory?).with('site').and_return(true)
+      allow(File).to receive(:directory?).with('site/subdir').and_return(false)
+    end
+
+    it 'should write a file and update mtime to match source files' do
+      page = OpenStruct.new name: 'test.slim', input_path: 'src/test.slim', output_filename: 'test.html', render: '<!DOCTYPE html><h1>It works!</h1>'
+      expect(File).to receive(:write).with('site/test.html', '<!DOCTYPE html><h1>It works!</h1>')
+      expect(File).to receive(:stat).with('src/test.slim').and_return(OpenStruct.new mtime: 100)
+      expect(FileUtils).to receive(:touch).with('site/test.html', mtime: 100).and_return(true)
+      expect(FileUtils).to_not receive(:mkdir_p)
+
+      expect(generator.send :generate_page, page).to eq(nil)
+
+      expect(@log_output.readline).to eq("SUCCESS  Usmu::SiteGenerator : creating test.html...\n")
+      expect(@log_output.readline).to eq("  DEBUG  Usmu::SiteGenerator : Rendering test.html from test.slim\n")
+    end
+
+    it 'should create directories as necessary' do
+      page = OpenStruct.new name: 'test.slim', input_path: 'src/subdir/test.slim', output_filename: 'subdir/test.html', render: '<!DOCTYPE html><h1>It works!</h1>'
+      expect(File).to receive(:write).with('site/subdir/test.html', '<!DOCTYPE html><h1>It works!</h1>')
+      expect(File).to receive(:stat).with('src/subdir/test.slim').and_return(OpenStruct.new mtime: 100)
+      expect(FileUtils).to receive(:touch).with('site/subdir/test.html', mtime: 100).and_return(true)
+      expect(FileUtils).to receive(:mkdir_p).with('site/subdir')
+
+      expect(generator.send :generate_page, page).to eq(nil)
+    end
   end
 end

data/usmu.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rack', '~> 1.6'
   spec.add_dependency 'deep_merge', '~> 1.0'
   spec.add_dependency 'commander', '~> 4.2'
-  spec.add_dependency 'logging', '~> 1.8'
+  spec.add_dependency 'logging', '~> 2.0'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usmu
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: java
 authors:
 - Matthew Scharley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-24 00:00:00.000000000 Z
+date: 2015-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slim
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -285,6 +285,7 @@ files:
 - share/init-site/usmu.yml
 - spec/acceptance/full_site_build.feature
 - spec/acceptance/steps/full_site_build_steps.rb
+- spec/mock/usmu/mock_metadata_configuration.rb
 - spec/mock/usmu/mock_plugin.rb
 - spec/mock/usmu/mock_remote_files.rb
 - spec/spec_helper.rb
@@ -362,6 +363,7 @@ summary: A static site generator with a web-based frontend for editing.
 test_files:
 - spec/acceptance/full_site_build.feature
 - spec/acceptance/steps/full_site_build_steps.rb
+- spec/mock/usmu/mock_metadata_configuration.rb
 - spec/mock/usmu/mock_plugin.rb
 - spec/mock/usmu/mock_remote_files.rb
 - spec/spec_helper.rb