usmu 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8af1ee0fa144c05fa7f442c710988f5b9aed5da3
-  data.tar.gz: d701e607de71bf181ce4a221ccddc71e019fd349
+  metadata.gz: 77196cca8367431f548de3b4a0ed85b2d128962c
+  data.tar.gz: a36c3f979f669bd89a31962bb0ab71b770b6767a
 SHA512:
-  metadata.gz: 4a1e515b341f517f0f3b2f4dd99cb2943d2871c6c61be073a89c3eb6a348f20173fafc870cab3c297ef9f2d89bd08052790e4e34f04b6f5bfdd971f5f776cf08
-  data.tar.gz: 59a72aeec89ff001171d69bde9974dc0ea008efc5adeb2eba457efe28787f06c66a04b434ed804470ba230ea9972b5e762a1fb61fd1b2c7d1e0749642bca3b99
+  metadata.gz: a0fd7552173005b61b10310b20b5d882da9ce0007477dc1a3636b19f25cb9b3a99f322d165d02471b466426ef553f4cedd141eac353256d5ee87c1b145851fee
+  data.tar.gz: cb155deec549610d11dda459249894a7c94c26e44a7f07089871934620094ddab809895c7a6cd3060ddf3cff110b410b7264200cdeedf382e8411e64cad950c0

data/.travis.yml

@@ -5,33 +5,29 @@ rvm:
   - 2.0
   - 2.1
   - ruby-head
-  - jruby-19mode
-  - jruby-head
-  - rbx-2
-  - rbx-head
-gemfile:
-  - Gemfile
-  - Gemfile-jruby
+  - mruby-head
+  - rbx-2.1
+  - rbx-2.2
+  - rbx-2.3
+  - rbx-2.4
 matrix:
-  exclude:
-    - rvm: 1.9.3
-      gemfile: Gemfile-jruby
-    - rvm: 2.0
-      gemfile: Gemfile-jruby
-    - rvm: 2.1
+  include:
+    - rvm: jruby
       gemfile: Gemfile-jruby
-    - rvm: ruby-head
+    - rvm: jruby
       gemfile: Gemfile-jruby
-    - rvm: jruby-19mode
-      gemfile: Gemfile
+      env: JRUBY_OPTS='--2.0'
     - rvm: jruby-head
-      gemfile: Gemfile
-    - rvm: rbx-2
       gemfile: Gemfile-jruby
-    - rvm: rbx-head
+    - rvm: jruby-head
       gemfile: Gemfile-jruby
+      env: JRUBY_OPTS='--2.0'
   allow_failures:
-    - rvm: jruby-19mode
+    - rvm: 1.9.3
+    - rvm: jruby
     - rvm: jruby-head
-    - rvm: rbx-2
-    - rvm: rbx-head
+    - rvm: mruby-head
+    - rvm: rbx-2.1
+    - rvm: rbx-2.2
+    - rvm: rbx-2.3
+    - rvm: rbx-2.4

data/CHANGELOG.md

@@ -0,0 +1,82 @@
+# Usmu Change Log
+
+## 0.2.1
+
+Matthew Scharley <matt.scharley@gmail.com>
+
+* Add a proper description to the gemspecs (a0830bdb81582b5d2cf2c60215d725a8a47c8086)
+
+## 0.2.0
+
+Matthew Scharley <matt.scharley@gmail.com>
+
+* Add a logging library and a bunch of default messages (2691935b5a519378dbf41539f610bea58bc12f63)
+* Add a few basic commandline options (833098ae38f22b3699bc411ee806d26a4b36f1d9)
+* Update mtime in destination folder from source folder (558d03efd4f4f3875c7cf5b99ff18ec69cf5ba45)
+* Move contributing information to it's own file for GitHub's sake (f241549ced0c8804d406685a7d5877e7eb597262)
+* Add basic plugin loading. (a6fdad0e0331b7daa679db99c7c00e7fc1543363)
+* Fix issues with 'layout' as a default metadata property (9ae696aa9237adc5ba8048957eefcd4fb8f7782c)
+* Implement simplecov for rspec tests (606841eeed2e30801313aee56a815644f901a1b4)
+* Fix output extensions for all templates I know the answer for. (bad1eed984a634f1dd28ce198fa1e40a10b2c9c8)
+* Clean up configuration and simplecov a bit (bf4288e6155fdab9354616e65e5531e9a4e7ca0f)
+* Clean up coverage statistics a bit that were scewed (734563c8b627da33d853e453437790b4ca64b7a2)
+* Add tests for the CLI interface (8e1a520ed74000b180e780121a426f4fea55ad56)
+* Add guard for quick feedback on tests (7bae19eaad9728968e764ea237ee3dd6f0cd03ce)
+* Updates so specs can be run individually (6071120890347fd2c04bcfb4e8387d4b1dd839ba)
+* Use turnip for the few gherkin scripts we have (d018752de127c788ec79d1a65df12e4d1b3f03d3)
+* Remove cucumber from the CI task (d4094db005db5205542eb8256e86f01d9cd49d05)
+* Allow the rspec rake task to find it's own spec files (35d6f7e4486f14034544884090b5cccfd7bd82ad)
+* Use Redcarpet 3.2! (5c7a9d34f5ec2c12089b1e045e174f26f34877f2)
+* [GH-7] Allow for excluding files via usmu.conf (da0f1123316ce1cede23a63cea8e6c46c3a17a01)
+* Add one more guard test on exclude globs (143460ea5f5427845e01119a8aba039207382a1b)
+* [GH-5] Add an initial pass at a plugin system (73588da4bfaf03fa27a47747b56f6e31d95c8704)
+* [GH-5] Transition to commander instead of trollop and make `generate` an official command (1aaaf43c0884c70980af3b7e6fcaa8ce57f7474c)
+* 1.9.3 compatibility (cba51ad465576ac542111d200cfcbb62835c097c)
+* Re-enable 1.9.3 CI and add some compat notes to the readme (cf34053aaaf6a85752ec8be70f7c9969a89990d9)
+* Bump to 0.2.0 release (7e7dde04c180b5ae63268db647ba45ef63a6b3f3)
+
+## 0.1.0
+
+Matthew Scharley <matt.scharley@gmail.com>
+
+* Add some gems for testing (638e064d1bfbababf2a89a6197a6ac692dcba127)
+* Add an empty RSpec and Cucumber configuration with no tests (469881ef414558f27abf753335470564fd95c2dc)
+* Fix my mispellings (83b27fa4fa39453e50068d1f29ae717e6be12040)
+* Add a basic overarching test for a basic generator (c48a823bbdad7171b3cd530f8345a30710aeeaba)
+* Add a new embedded layout test (f982f4e3e6dfddefb1a5c952600afc1c45c57da1)
+* Add empty step definitions (a6c485fbcf5da30b3d65ab40820e251da56aecc1)
+* Add a bunch of information to the README (292acc057ca369e3544fb9ea0552d6e96a7b648e)
+* Update names to the new 'final' name (859ca5cd1523588e6d764d96304b9e62d7b5dc6c)
+* Grammar (ce48ccbc227c8a0871752cb97d296a68ad9c0139)
+* Add a few more dev tools (9be06d7e8be1edea83c14f43aeea0f5c1d6aa64f)
+* Fix license link (fce28223da57998980a398edc31415fa458bfd60)
+* Add Cane/Yard configurations (8dc2c5d8163f4f0fcbdb7c69fb0b49aac8745fa0)
+* Add a Travis CI configuration (2c78a309125e665499e0c45a6bb7e270c54282f9)
+* Add Travis tag to the readme (d6f1188a8db93c991203f86b592b8f02227fe31f)
+* Add configuration reading and final versions of cumumber steps (09b565c1ba5a7459a53e8c75fc0efcb29204316c)
+* Start to build out some specs (8435564ee4a3adc85c45742a34a7538fd3fbe8d2)
+* Only run specs on the CI for now (bff24ee9222da0e7184d77fbbff13062ef4d22ce)
+* Make RSpec a little less verbose in it's successes (15fc343c9faadfefa3212f790d10d48f06e60fe0)
+* Add some more options for travis (e4122c192629abff76227e218b5272fcbea1f37b)
+* Allow JRuby builds to fail. (b7bc4cdea0c4060326f290e71cbf4b494105ccf0)
+* Allow non-MRI builds to run but also allow them to fail (d29b17cbccf56ce1cbe9c29cc67e4db682a83230)
+* Add some more specs for Usmu::Configuration (7a0ae9a1727281b9bbf78c6dcbeb4983d3c1b083)
+* Add a workable Layout class (345028c1217c65ea78b7d805007c8c655d7d93e7)
+* Test jruby builds (98a490e1d66cd508695b767b43075f3f2446e432)
+* Disallow jruby failures (954b0eb96ddb5f4ea74066e0105e092ec8a13997)
+* Use Rspec 3.1.x not 3.x (f6221fbdc0e4bb7929df3390488a3e5ed0774b5a)
+* Convert layout spec to a shared example (a3047928e560d91cf50bd41939d932dc5ae5d617)
+* Add a functional Page class (009d0c4c8c48a4928a3c09642a205ebe7fca9328)
+* Switch from Maruku to Kramdown for jruby (8ad1336bdadb109018dd1eba35cf06a2728407ca)
+* Fix jruby tests by allowing config per provider not per template type (bdab71c2b7675f7a8b9f116556332a97472ea513)
+* Add a public attr_reader for name and type to Layout (011031c7663fc1e1e457ae38b69f2505b1e9a343)
+* Update README with minor change in functionality (0a95ce878a77a25135f8147663758922fd2528a5)
+* Stylistic fix (da849668ef37022e11d85ebaab48fa8a5ecedddd)
+* Large refactor of how Layout's are initialised and a new StaticFile class (81b0f3f9d707d9d9dc866713942d47217921c67f)
+* Some minor refactors inspired by cane (b2f7ed7ec78292fcd0dbfb57b13cef68103bff91)
+* Successfully generate a website! (f1952e8776337626606834607db557fd0301a8e2)
+* Allow jruby failures again (2926aab2dc14f6b7c35db80dc93be3a24becf7ab)
+* Add documentation across the board. Yard reports 100%! (3122de04ed052a31d391845ce87251d9823a3773)
+* 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)

data/README.md

@@ -35,14 +35,6 @@ slim:
   :pretty: true
 ```
 
-### Ruby Compatibility
-
-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

data/Rakefile

@@ -12,6 +12,11 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'test/spec'
 end
 
+desc 'Start an IRB session with local code available'
+task :irb do
+  exec 'bundle', 'exec', 'irb', '-I', 'lib'
+end
+
 desc 'Run all test scripts'
 task :test => [:clean, :spec]
 
@@ -21,6 +26,7 @@ task :ci => [:test]
 desc 'Clean up after tests'
 task :clean do
   [
+      'tmp',
       'test/coverage',
       'test/site/site',
       current_gems,
@@ -58,3 +64,29 @@ namespace :gem do
     sh "git tag #{Usmu::VERSION}" if File.exist? '.git'
   end
 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
+  until_c = args[:until_c]
+  cmd=`git log --pretty='format:%ci::::%an <%ae>::::%s::::%H' #{since_c}..#{until_c}`
+
+  entries = Hash.new
+  changelog_content = "\#\# #{Usmu::VERSION}\n\n"
+
+  cmd.lines.each do |entry|
+    date, author, subject, hash = entry.chomp.split('::::')
+    entries[author] = Array.new unless entries[author]
+    day = date.split(' ').first
+    entries[author] << "#{subject} (#{hash})" unless subject =~ /Merge/
+  end
+
+  # generate clean output
+  entries.keys.each do |author|
+    changelog_content += author + "\n\n"
+    entries[author].reverse.each { |entry| changelog_content += "* #{entry}\n" }
+  end
+
+  puts changelog_content
+end

data/bin/usmu

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

data/lib/usmu.rb

@@ -72,10 +72,12 @@ end
 %W{
   usmu/version
   usmu/configuration
-  usmu/static_file
-  usmu/layout
-  usmu/page
   usmu/site_generator
   usmu/plugin
   usmu/plugin/core
+  usmu/template/helpers
+  usmu/template/include
+  usmu/template/layout
+  usmu/template/page
+  usmu/template/static_file
 }.each { |f| require f }

data/lib/usmu/configuration.rb

@@ -58,6 +58,18 @@ module Usmu
       get_files layouts_path
     end
 
+    # @!attribute [r] layouts_path
+    # @return [String] the full path to the layouts folder
+    def includes_path
+      get_path @config['includes'] || 'includes'
+    end
+
+    # @!attribute [r] layouts_files
+    # @return [Array<String>] a list of renderable files in the layouts folder
+    def includes_files
+      get_files 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
@@ -114,7 +126,7 @@ module Usmu
     # @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|
+      Dir["#{directory}/**/{*,.??*}"].select {|f| !f.match(/\.meta.yml$/) }.map do |f|
         f[(directory.length + 1)..f.length]
       end.select {|f| not excluded? f}
     end

data/lib/usmu/plugin/core.rb

@@ -1,9 +1,13 @@
+require 'fileutils'
 
 module Usmu
   class Plugin
     class Core
-      def commands(ui, c)
+      def initialize
         @log = Logging.logger[self]
+      end
+
+      def commands(ui, c)
         @log.debug('Adding core console commands...')
         @ui = ui
         c.command(:generate) do |command|
@@ -11,6 +15,12 @@ module Usmu
           command.description = 'Generates your website using the configuration specified.'
           command.action &method(:command_generate)
         end
+
+        c.command(:init) do |command|
+          command.syntax = 'usmu init [path]'
+          command.description = 'Initialise a new website in the given path, or the current directory if none given.'
+          command.action &method(:command_init)
+        end
       end
 
       # @return [void]
@@ -18,6 +28,30 @@ module Usmu
         @site_generator = Usmu::SiteGenerator.new(@ui.configuration)
         @site_generator.generate
       end
+
+      def command_init(args, options)
+        @log.info("Usmu v#{Usmu::VERSION}")
+        @log.info('')
+
+        if args.length > 1
+          @log.fatal('Only one path allowed to be initialised at a time.')
+          raise
+        end
+
+        path = args.length == 1 ? args.shift : '.'
+        from = File.realpath(File.join(File.dirname(__FILE__), '../../../share/init-site'))
+
+        @log.info("Copying #{from} -> #{path}")
+        Dir["#{from}/**/{*,.??*}"].each do |file|
+          output_name = file[(from.length + 1)..file.length]
+          @log.success "Creating #{output_name}..."
+          unless File.directory? file
+            output_path = "#{path}/#{output_name}"
+            FileUtils.mkdir_p File.dirname(output_path) unless File.directory? File.dirname(output_path)
+            FileUtils.copy(file, output_path)
+          end
+        end
+      end
     end
   end
 end

data/lib/usmu/site_generator.rb

@@ -1,7 +1,7 @@
 require 'fileutils'
 require 'usmu/configuration'
-require 'usmu/page'
-require 'usmu/static_file'
+require 'usmu/template/page'
+require 'usmu/template/static_file'
 
 module Usmu
   # This is the class that brings everything together to generate a new website.
@@ -15,39 +15,39 @@ 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::Layout.new(@configuration, l) }
+      @configuration.layouts_files.map {|l| Usmu::Template::Layout.new(@configuration, l) }
     end
 
     # @!attribute [r] renderables
-    # @return [Array<Usmu::StaticFile>] a list of renderable files from the source folder.
+    # @return [Array<Usmu::Template::StaticFile>] a list of renderable files from the source folder.
     #   will be a subclass of this class.
     # @see Usmu::StaticFile
     #
     # Returns a list of renderable files from the source folder.
     #
     # The only guarantee made for individual files is that they will conform to the interface defined by
-    # Usmu::StaticFile and thus be renderable, however most files will be one of the subclasses of that class.
+    # 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::Layout.is_valid_file? 'source', filename
-          Usmu::Page.new(@configuration, filename)
+        if Usmu::Template::Layout.is_valid_file? 'source', filename
+          Usmu::Template::Page.new(@configuration, filename)
         else
-          Usmu::StaticFile.new(@configuration, filename)
+          Usmu::Template::StaticFile.new(@configuration, filename)
         end
       end
     end
 
     # @!attribute [r] pages
-    # @return [Array<Usmu::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::StaticFile'}
+      renderables.select {|r| r.class.name != 'Usmu::Template::StaticFile'}
     end
 
     # @!attribute [r] files
-    # @return [Array<Usmu::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::StaticFile'}
+      renderables.select {|r| r.class.name == 'Usmu::Template::StaticFile'}
     end
 
     # Generate the website according to the configuration given.

data/lib/usmu/template/helpers.rb

@@ -0,0 +1,19 @@
+# We really should include this, but it causes an include loop and Include has a strict dependency on Layout due to
+# the inheritance structure. Oh well. Perhaps I'll think of something later.
+#require 'usmu/template/include'
+
+module Usmu
+  module Template
+    class Helpers
+      def initialize(configuration)
+        @configuration = configuration
+      end
+
+      def include(name, args = {})
+        inc = Usmu::Template::Include.find_include(@configuration, name)
+        inc.arguments = args
+        inc.render
+      end
+    end
+  end
+end

data/lib/usmu/template/include.rb

@@ -0,0 +1,87 @@
+require 'usmu/template/layout'
+
+module Usmu
+  module Template
+    # Represents a page in the source directory of the website.
+    class Include < Layout
+
+      private
+
+      alias :layout_metadata :metadata
+
+      public
+
+      # @!attribute [rw] arguments
+      # @return [Hash] the arguments associated with this include
+      attr_accessor :arguments
+
+      # Static method to create an include 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::Include already for testing purposes.
+      # @return [Usmu::Layout]
+      def self.find_include(configuration, name)
+        if name === 'none'
+          nil
+        elsif name.class.name == 'String'
+          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])
+            end
+          end
+          nil
+        else
+          name
+        end
+      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
+        meta = layout_metadata
+        # Includes must never allow layout inheritance.
+        meta['layout'] = nil
+
+        meta
+      end
+
+      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.includes_path
+      end
+
+      private
+
+      # Utility function which collates variables to pass to the template engine.
+      #
+      # @return [Hash]
+      def get_variables(variables)
+        args = {}
+        arguments.each do |i, value|
+          args[i.class.name == 'String' ? i : i.to_s] = value
+        end
+        
+        {'site' => @configuration}.deep_merge!(metadata).deep_merge!(args).deep_merge!(variables)
+      end
+    end
+  end
+end