dinner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fbeb0b0678789d34dd454e4103a0350f22c7542
+  data.tar.gz: 2c1768e344c5f3969679a2056ddfe76d832fe5ac
+SHA512:
+  metadata.gz: 10820ec69a2be7bb2d4a89889dcba41d3d824bf02b3e785a3c31861908af29ebeedcb3d8ba64e7a4f8fc2472e5b823662ae1376b67669e368422acd444faf19b
+  data.tar.gz: 478c0cf84c9bef188bf3f0e5f213652335106191e90f1b9bee5050bac68e675e725e5f3357565db750b58ed8c620338e28c48289c771238a4082c9b84eb7fac3

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+test/
+test2/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dan Turkel
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,132 @@
+# Dinner.rb
+
+- [What's Dinner?](#what)
+- [Installation](#install)
+- [Usage](#usage)
+- [Example](#example)
+- [Uninstallation](#uninstall)
+- [Contributing](#contribute)
+
+## <a name="what">What's Dinner?</a>
+
+Dinner is a Ruby gem designed to replicate some of the feature set of [Hammer](http://hammerformac.com/) for Mac. I'm a huge fan of Hammer's ability to do HTML includes and variables, so I made Dinner to see how well I could do it myself without the app, 'cause why not?
+
+Basically, you can write HTML pages with lines like `<!-- @include _header.html -->` and then Dinner will automagically copy your header file into all of your HTML pages, allowing you to edit that header file and see your changes propagate across all your files after running Dinner! This is perfect for building static sites where you don't want to bother with PHP includes but still want to be able to easily edit your templates (or 'plates, hence Dinner, get it?).
+
+The project is similar in scope to [grunt-includes](https://github.com/vanetix/grunt-includes) but does not involve setting up [grunt](http://gruntjs.com/) tasks, uses a different syntax, and is Ruby-based rather than JS based.
+
+### What it does so far:
+
+- Include `_foo.html` files into `bar.html` files and move the compiled results into a build directory, but only when you manually run the app
+- Makes a `dinconfig.yaml` file where you can:
+    - Edit the build folder name
+    - More to come
+- Finds placeholder tags and switches them for [placehold.it](http://placehold.it) `img` tags. (See [Example](#example) below)
+- That's basically it
+
+### What I'm going to do for sure
+- Better documentation
+- Support Hammer-style [HTML variables](http://hammerformac.com/docs/tags/variables)
+- Fix behavior with HTML files that are inside directories in the working directory (currently the directory structure will be flattened inside the build folder)
+- Copying CSS and JS files (perhaps more) to the build folder so that loading the build file in a web browser will not result in dead links to stylesheets and scripts which are in the parent directory
+- <del>Make a easy-to-use YAML config file where you can change:</del> done!
+    - <del>Edit the build folder name</del> done!
+    - what non-HTML files should be copied to the build directory (and if you want them minified)
+    - probably more stuff
+- Use the [listen](https://github.com/guard/listen) gem to automatically recompile files when they're edited, so the app doesn't need to be manually run
+- Add rspec tests
+- Put it on RubyGems when it's moderately ready
+- <del>Replicate Hammer's [image placeholders](http://hammerformac.com/docs/tags/placeholder) feature</del> done!
+
+### What maybe I'll do
+- Support includes within includes
+- Support includes that are not in `_foo.html` name format
+- Replicate Hammer's [navigation helpers](http://hammerformac.com/docs/tags/navigation.html) feature
+- Add Sass/SCSS compilation
+
+### What I definitely won't do but feel free to contribute
+- Coffeescript compilation
+- Replicate Hammer's [cache](http://hammerformac.com/docs/cache) feature
+
+
+## <a name="install">Installation</a>
+
+Dinner isn't on RubyGems yet and is still in early dev stages. If you want to play with it or contribute, go ahead and run
+
+    git clone https://github.com/daturkel/dinner.rb.git
+
+Then `cd` to the cloned directory and run
+
+    gem build dinner.gemspec
+
+followed by
+
+    gem install *.gem
+
+## <a name="usage">Usage</a>
+
+**Warning**: This product is in early alpha and if used improperly, or if I messed something up, could easily trash your files. I recommend you make a backup of your entire working directory or use version control before running `dinner` in your directory (at least at this early stage of development). By using `dinner`, you do so at your own risk.
+
+Right now, since Dinner's functionality is fairly limited, this section is quite simple! After installing the gem, simply `cd` to your working directory. If you have not already, you should isolate all your project files into their own directory to avoid accidental compilation of other unrelated files. 
+
+Write HTML pages into files with typical names (`about.html`) and files that will be included into files that have leading-underscore names (`_header.html`). In your page files (like `about.html`), where you want an include, insert a single line with a comment in this form: `<!-- @include _foo.html -->` (or, alternatively, as `<!-- @include _foo -->`, without the `.html`, Dinner will assume you meant it) where `_foo.html` is the name of your include file. When you run `dinner` in the working directory, Dinner will automatically find the include file and replace the comment with it, verbatim (no changes to indent amount or anything) and output the new page into your `build/` directory. If Dinner is unable to find an include file, it will simply leave the comment in place and alert you with an error message in the terminal.
+
+## <a name="example">Example</a>
+In `about.html`:
+
+```html
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+	<title>About me!</title>
+</head>
+
+<body>
+    <!-- @include _head.html -->
+    <h2>Welcome</h2>
+    <!-- @placeholder 300x400 --><!-- @placeholder 400x500 -->
+    <p>This site is all about me! Isn't it neato?</p>
+</body>
+</html>
+```
+
+In `_head.html`:
+```html
+    <p>This banner goes across every page of my website and now I can change it on all of them easily!</p>
+    <p>That's sick!</p>
+```
+
+And, after Dinner has been run, in `build/about.html`:
+````html
+<!DOCTYPE HTML>
+<html lang="en">
+<head>
+	<title>About me!</title>
+</head>
+
+<body>
+    <p>This banner goes across every page of my website and now I can change it on all of them easily!</p>
+    <p>That's sick!</p>
+    <h2>Welcome</h2>
+    <img src="http://placehold.it/300x400"><img src="http://placehold.it/400x500">
+    <p>This site is all about me! Isn't it neato?</p>
+</body>
+</html>
+````
+
+It's that easy!
+
+## <a name="uninstall">Uninstallation</a>
+
+To uninstall dinner, simply run `gem uninstall dinner` and when prompted to remove the executable, answer `y`.
+
+
+## <a name="contribute">Contributing</a>
+
+Feel free to contribute by filing an issue or submitting a pull request:
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/dinner

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'dinner'
+
+Dinner.do_everything

data/dinner.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fileutils'
+require 'find'
+require 'listen'
+require 'yaml'
+require 'dinner/version'
+require 'dinner/configmanager'
+require 'dinner/filemanager'
+require 'dinner/htmlmangler'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dinner"
+  spec.version       = Dinner::VERSION
+  spec.authors       = ["daturkel"]
+  spec.email         = ["daturkel@gmail.com"]
+  spec.description   = %q{Use dinner to automatically include html files!}
+  spec.summary       = %q{The 'plating engine.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/dinner.rb

@@ -0,0 +1,29 @@
+# Dinner is a Ruby gem for HTML includes.
+#
+# Author:: Dan Turkel (mailto:daturkel@gmail.com)
+# Copyright:: Copyright (c) 2014 Dan Turkel
+# License:: MIT License
+
+require_relative 'dinner/version'
+require_relative 'dinner/filemanager'
+require_relative 'dinner/htmlmangler'
+require_relative 'dinner/configmanager'
+require 'fileutils'
+require 'find'
+require 'listen'
+require 'yaml'
+
+# This module is the primary Dinner namespace used to wrap the functionality of the rest of the app
+module Dinner
+
+  # Run Dinner
+  def self.do_everything
+    ConfigManager.init_config
+    FileManager.init_build(FileManager.locate_html(true,false))
+    HtmlMangler.insert_includes(FileManager.locate_html(false,true))
+    HtmlMangler.insert_placeholders(FileManager.locate_html(false,true))
+  end
+
+end
+
+Dinner.do_everything

data/lib/dinner/configmanager.rb

@@ -0,0 +1,39 @@
+# This class is for creating/accessing a config file with options for Dinner
+class ConfigManager
+
+  # The defaults for the config file
+  DEFAULT = {
+    :build_folder => "build",
+    :copy_formats => ["js","css"]
+  }
+
+  @@config = {}
+
+  # Access the configuration hash
+  def self.config
+    @@config
+  end
+
+  # A getter method for the config defaults
+  def self.default
+    DEFAULT
+  end
+
+  # Create a config file if there isn't yet one
+  def self.init_config
+    if File.exists?("#{Dir.pwd}/dinconfig.yaml")
+      self.load_config("#{Dir.pwd}/dinconfig.yaml")
+    else
+      File.open("#{Dir.pwd}/dinconfig.yaml","w+") do |file|
+        file.puts(DEFAULT.to_yaml)
+      end
+      self.load_config("#{Dir.pwd}/dinconfig.yaml")
+    end
+  end
+
+  # Load the current config file
+  def self.load_config(file_path)
+    @@config = YAML.load(File.read(file_path))
+  end
+end
+

data/lib/dinner/filemanager.rb

@@ -0,0 +1,53 @@
+# A module for locating files and creating the build folder
+module FileManager
+
+  # Find the html files and return a hash containing an array of page files (:files) and an array of include files (:includes)
+  def self.locate_html(with_includes,in_build = false)
+    html = { :files => {}}
+    if with_includes
+      html[:includes] = {}
+    end
+    if in_build
+      dir = "#{Dir.pwd}/#{ConfigManager.config[:build_folder]}"
+    else
+      dir = Dir.pwd
+    end
+    Find.find(dir) do |path|
+      if FileTest.directory?(path)
+        if (File.basename(path) == ConfigManager.config[:build_folder]) && !in_build
+          Find.prune
+        else
+          next
+        end
+      else
+        if path =~ /.*\/[^_][^\/]*\.html$/
+          html[:files][File.basename(path)] = path
+        elsif path =~ /.*\/[_][^\/]*\.html$/ and with_includes
+          html[:includes][(File.basename(path)[1..-1])] = path
+        end
+      end
+    end
+    return html
+  end
+
+  # Create the build folder if it does not exist. If it does exist, prunes it of old files. Then it moves in the unprocessed page-files.
+  # @TODO: Split this into two functions, one to create the build folder if it doesn't exist, and one to delete files which will be replaced
+  def self.init_build(html)
+    if Dir.exists?(ConfigManager.config[:build_folder])
+      Find.find("#{Dir.pwd}/#{ConfigManager.config[:build_folder]}") do |path|
+        File.delete(path) if File.extname(path) == ".html"
+      end
+    else
+      Dir.mkdir "#{Dir.pwd}/#{ConfigManager.config[:build_folder]}"
+    end
+    self.push_files(html)
+  end
+
+  def self.push_files(html)
+    html[:files].each_value do |path|
+      FileUtils.cp(path,"#{Dir.pwd}/#{ConfigManager.config[:build_folder]}")
+    end
+  end
+
+end
+

data/lib/dinner/htmlmangler.rb

@@ -0,0 +1,75 @@
+# A module for editing the HTML of files being processed with dinner
+module HtmlMangler
+
+  # Find @include commands in an html document and replace them with the contents of the correct file, or else display an error in the shell and leave the @include command in place
+  def self.insert_includes(html)
+    a = 0
+    html[:files].each_pair do |name,path|
+      lines = IO.readlines(path)
+      lines.each_with_index do |line,i|
+        if line =~ /^\s*<!-- @include.*/
+          if File.exists?("#{Dir.pwd}/#{parse_filename(line)}")
+            lines[i] = File.read("#{Dir.pwd}/#{parse_filename(line)}")
+            a = i
+          else
+            puts "Error in #{name}, line #{i+1}: #{parse_filename(line)} missing"
+          end
+        end
+      end
+      File.open("#{Dir.pwd}/#{ConfigManager.config[:build_folder]}/#{name}","w+") do |file|
+        file.puts(lines)
+      end
+    end
+  end
+
+  # Take a line of an html page file and derive the name of the referenced file from it
+  def self.parse_filename(line)
+    clean_line = line.dup
+    clean_line.slice!("<!-- @include")
+    clean_line.slice!("-->")
+    clean_line.strip!
+    if clean_line.include?(".html")
+      return clean_line
+    else
+      return clean_line + ".html"
+    end
+  end
+
+  # Replace variables
+  def self.insert_variables(html)
+    a = 0
+    html[:files].each_pair do |name,path|
+      lines = IO.readlines(path)
+      lines.each_with_index do |line,i|
+        if line =~ /^\s*<!-- \$.*/
+          # @TODO figure out how best to pick out those variable names
+        end
+      end
+    end
+  end
+
+  # Auto-insert placeholder images
+  def self.insert_placeholders(html)
+    html[:files].each_pair do |name,path|
+      lines = IO.readlines(path)
+      lines.each_with_index do |line,i|
+        while line =~ /.*<!-- @placeholder.*/
+          info = parse_placeholder(line.match(/<!--[^>]*?-->/)[0])
+          line = line.sub(/<!--[^>]*?-->/,"<img src=\"http://placehold.it/#{info[:res]}\">")
+          lines[i] = line
+        end
+      end
+      File.open("#{Dir.pwd}/#{ConfigManager.config[:build_folder]}/#{name}","w+") do |file|
+        file.puts(lines)
+      end
+    end
+  end
+
+  def self.parse_placeholder(line)
+    info = {}
+    info[:res] = line.match(/\d*x\d*/)[0]
+    info
+  end
+
+end
+

data/lib/dinner/version.rb

@@ -0,0 +1,5 @@
+# A module containing the current version number of Dinner
+module Dinner
+  VERSION = "0.1.0"
+end
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: dinner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- daturkel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Use dinner to automatically include html files!
+email:
+- daturkel@gmail.com
+executables:
+- dinner
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/dinner
+- dinner.gemspec
+- lib/dinner.rb
+- lib/dinner/configmanager.rb
+- lib/dinner/filemanager.rb
+- lib/dinner/htmlmangler.rb
+- lib/dinner/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: The 'plating engine.
+test_files: []