bgotink-hyde 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b35e2e38e70e2040272eb73e09c1723addeb037e
-  data.tar.gz: 649a9dc6e5865353fd824b0bda1d00c371912e09
+  metadata.gz: b081f21b5c869455b93b00f9ebe7eff282203e4b
+  data.tar.gz: a9cb5777018d9612c8e3ae2128f05c5a833760ca
 SHA512:
-  metadata.gz: ba3173c30ede6cba47322d3758b5972f475ba9222ce37fd0ef032c2f5ce4e8ae0bbaf7d6d07c4d54d152776ff53e22ee31cfd040fc7857257eb254b354110d9e
-  data.tar.gz: ae6bcd9e3c0f1ce2b1d7fd0ce49bc25aaa58d0be1f7d3d26618f2c38430f49ca1bdffd33517dd34988fb4e339ca760a1db06566f118f20387cb2fa5feca6660c
+  metadata.gz: eb102e9467d222bb06d68f95132fa58df9ae963497e540fddf7ce179c2c03b84007962a087d707022fe783c7cd408c8fed1b853d018f6b079a628507a1a7f81a
+  data.tar.gz: 807d0a1b29aa0f87988260d036239c8ff541eaaf6ef7f87244805f5085c063dc1a2db109debcbd856270c27fce8dd2e6be05a729b0e91efd6eab783a1af35c45

data/History.md

@@ -1,4 +1,15 @@
-## HEAD
+## 0.2.0 / 2014-01-08
+
+### Major Enhancements
+  * moved from `map` to `pages` and `posts` in `_config.yml`
+  * allow files to be included in `pages` and `posts` directly instead of requiring directories
+  * automatically checkout jekyll template from different branch while building
+  * also allow destination to be a git branch
+  
+### Bugfixes
+  * fixed rake release
+
+## 0.1.0 / 2014-01-08
 
 ### Major Enhancements
   * copied and modified gemspec, rakefile etc. from [jekyll](//github.com/jekyll/jekyll)

data/bgotink-hyde.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'bgotink-hyde'
-  s.version           = '0.1.0'
+  s.version           = '0.2.0'
   s.license           = 'MIT'
   s.date              = '2014-01-08'
   s.rubyforge_project = 'bgotink-hyde'
@@ -59,7 +59,8 @@ Gem::Specification.new do |s|
     lib/hyde/commands/build.rb
     lib/hyde/commands/serve.rb
     lib/hyde/configuration.rb
-    lib/hyde/jekyllfile.rb
+    lib/hyde/page.rb
+    lib/hyde/post.rb
     lib/hyde/site.rb
     lib/hyde/stevenson.rb
   ]

data/lib/hyde.rb

@@ -10,7 +10,8 @@ def require_all(directory)
 end
 
 require 'hyde/configuration'
-require 'hyde/jekyllfile'
+require 'hyde/page'
+require 'hyde/post'
 require 'hyde/site'
 require 'hyde/command'
 require 'hyde/stevenson'
@@ -18,7 +19,7 @@ require 'hyde/stevenson'
 require_all 'hyde/commands'
 
 module Hyde
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 
   # Public: Generate a Hyde configuration Hash by merging the default
   # options with anything in _config.yml, and adding the given options on top.
@@ -43,8 +44,8 @@ module Hyde
   def self.jekyll_configuration(configuration)
     config = Jekyll::Configuration[Jekyll::Configuration::DEFAULTS]
     override = Jekyll::Configuration[{
-      'source' => configuration['jekyll-out'],
-      'destination' => configuration['destination']
+      'source' => configuration['intermediary']['directory'],
+      'destination' => configuration['destination']['directory']
     }].stringify_keys
     config = config.read_config_files(config.config_files(override))
     

data/lib/hyde/commands/build.rb

@@ -13,9 +13,9 @@ module Hyde
       
       def self.build(site, options)
         source = options['source']
-        jekyll = options['jekyll']
-        jekyll_out = options['jekyll-out']
-        destination = options['destination']
+        jekyll = options['template']['directory']
+        jekyll_out = options['intermediary']['directory']
+        destination = options['destination']['directory']
         
         Hyde.logger.info "Source:", source
         Hyde.logger.info "Jekyll input:", jekyll
@@ -35,13 +35,11 @@ module Hyde
         # TODO check whether dest is in source?
         
         source = options['source']
-        intermediary = options['jekyll-out']
-        destination = options['destination']
 
         ignored = Array.new
-        %w[jekyll-out destination].each do |o|
+        %w[intermediary destination].each do |o|
           begin
-            d = Pathname.new(options[o]).relative_path_from(Pathname.new(source)).to_s
+            d = Pathname.new(options[o]['directory']).relative_path_from(Pathname.new(source)).to_s
             ignored << Regexp.escape(d)
           rescue ArgumentError
             # nop

data/lib/hyde/commands/serve.rb

@@ -1,7 +1,8 @@
 module Hyde
   module Commands
-    class Serve < Hyde::Command
+    class Serve < Command
       def self.process(options)
+        Hyde.logger.info "Starting server...", ''
         Jekyll::Commands::Serve.process(Hyde::jekyll_configuration(options))
       end
     end

data/lib/hyde/configuration.rb

@@ -3,9 +3,18 @@ module Hyde
     
     DEFAULTS = {
       'source' => Dir.pwd,
-      'jekyll' => File.join(Dir.pwd, '_jekyll'),
-      'jekyll-out' => File.join(Dir.pwd, '_jekyll-out'),
-      'destination' => File.join(Dir.pwd, '_site'),
+      'template' => {
+        'directory' => File.join(Dir.pwd, '_template'),
+        'branch' => nil,
+        'update' => true
+      },
+      'intermediary' => {
+        'directory' => File.join(Dir.pwd, '_intermediary')
+      },
+      'destination' => {
+        'directory' => File.join(Dir.pwd, '_site'),
+        'branch' => nil
+      },
       
       'keep' => false,
       
@@ -14,6 +23,9 @@ module Hyde
       'safe' => false,
       'detach' => false,
       
+      'pages' => Hash.new,
+      'posts' => Hash.new,
+      
       'port'          => Jekyll::Configuration::DEFAULTS['port'],
       'host'          => Jekyll::Configuration::DEFAULTS['host']
     }

data/lib/hyde/{jekyllfile.rb → page.rb}

@@ -1,26 +1,38 @@
 module Hyde
   
-  class JekyllFile
-    attr_accessor :original, :destination
+  class Page
+    attr_accessor :original, :name, :time
     
     def initialize(location, destination)
-      self.original = File.absolute_path(location)
+      @original = File.absolute_path(location)
+      @dest_dir = destination
+      
       data = read_yaml(self.original)
     
-      name = File.basename(location)
-      time = if data['hyde_date']
-               Time.parse(data['hyde_date'])
-             else 
-               File.mtime(location)
-             end
+      @name = File.basename(location)
+      @time = if data['hyde_date']
+                Time.parse(data['hyde_date'])
+              elsif data['date']
+                Time.parse(data['date'])
+              else 
+                File.mtime(location)
+              end
+    end
     
-      dest_file_name = "#{time.strftime('%Y-%m-%d')}-#{name}"
+    def dest_filename
+      name
+    end
+    
+    def dest_dir
+      @dest_dir
+    end
     
-      self.destination = File.join(destination, dest_file_name)
+    def destination
+      File.join(dest_dir, dest_filename)
     end
   
     def write
-      File.symlink(self.original, self.destination)
+      File.symlink(original, destination)
     end
     
     private

data/lib/hyde/post.rb

@@ -0,0 +1,13 @@
+module Hyde
+  
+  class Post < Page
+    def dest_filename
+      "#{time.strftime('%Y-%m-%d')}-#{name}"
+    end
+    
+    def dest_dir
+      File.join(super, '_posts')
+    end
+  end
+  
+end

data/lib/hyde/site.rb

@@ -1,15 +1,19 @@
 module Hyde
   
   class Site
-    attr_accessor :config, :map, :source, :jekyll_source, :dest, :time, :files
+    attr_accessor :options, :pages, :posts
+    attr_accessor :source, :template, :dest
+    attr_accessor :time, :files
     
-    def initialize(config)
-      self.config = config
+    def initialize(options)
+      self.options = options
       
-      self.map = config['map'] || {}
-      self.source = File.expand_path(config['source'])
-      self.jekyll_source = File.expand_path(config['jekyll'])
-      self.dest = File.expand_path(config['jekyll-out'])
+      self.pages = options['pages']
+      self.posts = options['posts']
+
+      self.source = File.expand_path(options['source'])
+      self.template = File.expand_path(options['template']['directory'])
+      self.dest = File.expand_path(options['intermediary']['directory'])
       
       self.reset
       self.setup
@@ -26,8 +30,8 @@ module Hyde
     
     # reset the time
     def reset
-      self.time = if self.config['time']
-                    Time.parse(self.config['time'].to_s)
+      self.time = if options['time']
+                    Time.parse(options['time'].to_s)
                   else
                     Time.now
                   end
@@ -35,95 +39,145 @@ module Hyde
     
     # copy Jekyll source files
     def setup
-      FileUtils.rm_rf(self.dest)
-      FileUtils.cp_r(self.jekyll_source, self.dest, :preserve => true)
+      if options['destination']['branch']
+        clone_directory(options['destination'])
+      else
+        FileUtils.rm_rf(dest)
+      end
+      
+      clone_directory(options['template']) if options['template']['branch']
+      
+      FileUtils.rm_rf(dest)
+      FileUtils.cp_r(template, dest, :preserve => true)
     end
+      
+    private
     
-    # create the Hyde-to-Jekyll output directories
-    def directories
-      self.map.each do |source_d, dest_d|
-        source = File.join(self.source, source_d)
-        if File.exists?(source)
-          dest = File.join(self.dest, dest_d)
-          if File.exists?(dest)
-            Hyde.logger.abort_with 'Illegal file:' "Expected destination file #{dest_d}/_posts to be a directory but found a file" unless File.directory?(dest)
-            Hyde.logger.warn 'Destination exists:', "Destination directory #{dest_d} exists, deleting content" unless self.config['watching']
-            
-            Dir[File.join(dest, '*')].each do |f|
-              FileUtils.rm_rf(f)
-            end
-          else
-            FileUtils.mkdir_p(dest)
+    def clone_directory(options)
+      directory = options['directory']
+      branch = options['branch']
+      update = (options['update'] == true || options['update'] == 'true')
+      
+      unless File.directory?('.git')
+        Hyde.logger.abort_with "Not a git repo:", "The current directory is not a git repository."
+      end
+      
+      if File.exists?(directory)
+        if File.directory?(directory)
+          # if git: cd && git pull
+          if File.directory?(File.join(directory, '.git')) and update
+            Hyde.logger.info 'Updating directory:', "Pulling branch #{branch} in #{directory}..."
+            `cd #{directory} && git pull`
+            Hyde.logger.info '', 'done'
+          elsif update
+            Hyde.logger.warn 'Expected git repo:', "Expected #{directory} to be a git repo"
+            Hyde.logger.warn '', 'as a branch was supplied to pull from.'
           end
         else
-          Hyde.logger.warn 'File not found:', "Directory #{source_d} does not exist, skipping directory"
+          Hyde.logger.abort_with 'Expected directory:', "#{directory} but found file"
         end
+      else
+        Hyde.logger.info 'Cloning template:', "Cloning branch #{branch} into #{directory}..."
+        `git new-workdir . #{directory} #{branch}`
+        Hyde.logger.info '', 'done.'
       end
     end
     
-    # read files
-    def read
-      self.files ||= Hash.new
-      self.map.each do |source_d, dest_d|
-        files = Hash.new
-        Hyde.logger.error 'Duplicate source:', "directory \"#{source_d}\"" if self.files[source_d]
-        self.files[source_d] = files
-        
-        read_directory(source_d, files, File.join(self.dest, dest_d))
-      end
+    public
+    
+    # create the Hyde-to-Jekyll output directories
+    def directories
+      directories_helper(pages)
+      directories_helper(posts, '_posts')
     end
     
     private
     
-    def read_directory(directory, data, destination)
-      Dir[File.join(directory, '*')].sort.each do |file|
-        if File.directory?(file)
-          fdata = Hash.new
-          read_directory(file, fdata, destination)
-          data[File.basename(file)] = fdata
-        else
-          data[File.basename(file)] = JekyllFile.new(file, destination)
+    def directories_helper(data, dest_suffix = '')
+      data.each do |source, dest|
+        source = File.join(self.source, source)
+        dest = File.join(self.dest, dest, dest_suffix)
+
+        unless File.exists?(source)
+          Hyde.logger.warn 'File not found:', "File/directory #{source} does not exist, skipping"
+          return
+        end
+
+        if File.exists?(dest)
+          unless File.directory?(source) == File.directory?(dest)
+            Hyde.logger.abort_with 'Illegal file:', "Expected #{dest} to be a #{File.directory?(source) ? 'directory but found file.' : 'file but found directory.'}" 
+          end
+
+          FileUtils.rm_rf(dest)
+        end
+
+        # if directory: create directory, otherwise nop
+        if File.directory?(source)
+          FileUtils.mkdir_p(dest)
         end
       end
     end
     
     public
     
-    # write jekyll files
-    def write
-      self.files.each do |name, files|
-        write_recursive(files, File.join(self.dest, self.map[name]))
+    # read files
+    def read
+      self.files ||= Array.new
+      
+      read_files(pages) do | source, destination |
+        files << Page.new(source, File.join(self.dest, destination))
+      end
+      read_files(posts) do | source, destination |
+        files << Post.new(source, File.join(self.dest, destination))
       end
     end
     
     private
     
-    def write_recursive(files, directory)
-      files.each do |name, file|
-        if file.is_a?(JekyllFile)
-          file.write
+    def read_files(files)
+      files.each do | source, destination |
+        if File.directory?(source)
+          read_directory(source, destination) { |s,d| yield(s,d) }
         else
-          write_recursive(file, directory)
+          yield(source, destination)
+        end
+      end
+    end
+    
+    def read_directory(directory, destination)
+      Dir[File.join(directory, '*')].sort.each do |source|
+        if File.directory?(source)
+          read_directory(source, destination) { |s,d| yield(s,d) }
+        else
+          yield(source, destination)
         end
       end
     end
     
     public
     
+    # write jekyll files
+    def write
+      files.each do |file|
+        file.write
+      end
+    end
+    
     # cleanup
     def cleanup
-      self.files = Hash.new
-      FileUtils.rm_rf(self.dest) unless self.config['keep'] or self.config['watching']
+      self.files = Array.new
+      FileUtils.rm_rf(self.dest) unless options['keep'] or options['watching'] or options['serving']
     end
     
     # runs Jekyll
     def build
       jekyll_options = Hash.new
       
-      %w[safe destination verbose].each do |c|
-        jekyll_options[c] = self.config[c] if self.config[c]
+      %w[safe verbose].each do |c|
+        jekyll_options[c] = options[c] if options[c]
       end
 
+      jekyll_options['destination'] = options['destination']['directory']
       jekyll_options['source'] = self.dest
 
       jekyll_options = Jekyll::configuration(jekyll_options)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bgotink-hyde
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bram Gotink
@@ -102,7 +102,8 @@ files:
 - lib/hyde/commands/build.rb
 - lib/hyde/commands/serve.rb
 - lib/hyde/configuration.rb
-- lib/hyde/jekyllfile.rb
+- lib/hyde/page.rb
+- lib/hyde/post.rb
 - lib/hyde/site.rb
 - lib/hyde/stevenson.rb
 homepage: http://github.com/bgotink/hyde