prow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d9f41da04659cd12b91b480085140b2aa08b2183
+  data.tar.gz: 1968e6faab6709adb7f59fc9069191db2cb0879e
+SHA512:
+  metadata.gz: 77b8bd8d581e538817c8bec5821d167404524646769d8a483b146ba78030994964a87ad9bd4b41d140391221f3715d7055a35780318bcf8dbc8b5c226d6c2633
+  data.tar.gz: 3f9cccc3e5142e43db96e7e160e25ee54d1d0baa4bf55c649dd2aae0f27642e31426217b9c0e0df58107066e0d506b9f978eaf827e651e06bd395d39eaea3d3d

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+spec/support/public

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-gemset

@@ -0,0 +1 @@
+prow

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prow.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kane Baccigalupi
+
+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,29 @@
+# Prow
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'prow'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install prow
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/prow/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/prow/default_paths.rb

@@ -0,0 +1,19 @@
+module Prow
+  class DefaultPaths
+    def base_path
+      File.dirname(__FILE__) + "/.."
+    end
+
+    def config_path
+      "#{base_path}/pages.json"
+    end
+
+    def templates_path
+      "#{base_path}/templates"
+    end
+
+    def compiled_path
+      "#{base_path}/public"
+    end
+  end
+end

data/lib/prow/page_compiler.rb

@@ -0,0 +1,33 @@
+module Prow
+  class PageCompiler < Struct.new(:name, :config, :templates, :compile_dir)
+    def compile
+      File.open(path, 'w+') do |f|
+        f.write(render)
+      end
+    end
+
+    def renderer
+      return @renderer if defined?(@renderer)
+      @renderer = Renderer.new
+      @renderer.templates = templates
+      @renderer.page_name = name.split('.').first
+      @renderer
+    end
+
+    def render
+      renderer.render(layout.content, data)
+    end
+
+    def layout
+      templates.layout(config['layout'] || 'default')
+    end
+
+    def data
+      config['data'] || {}
+    end
+
+    def path
+      compile_dir + "/" + name
+    end
+  end
+end

data/lib/prow/page_configs.rb

@@ -0,0 +1,15 @@
+module Prow
+  class PageConfigs < Struct.new(:path)
+    extend Forwardable
+
+    def load
+      JSON.parse(File.read(path))
+    end
+
+    def collection
+      @collection ||= load['pages'] || []
+    end
+
+    def_delegators :collection, :each, :size
+  end
+end

data/lib/prow/pages_compiler.rb

@@ -0,0 +1,29 @@
+module Prow
+  class PagesCompiler
+    attr_reader :config_path, :templates_path, :compile_path
+
+    def initialize(config_path=nil, templates_path=nil, compile_path=nil)
+      @config_path = config_path || default_paths.config_path
+      @templates_path = templates_path || default_paths.templates_path
+      @compile_path = compile_path || default_paths.compile_path
+    end
+
+    def compile
+      page_configs.each do |page_name, page_config|
+        PageCompiler.new(page_name, page_config, templates, compile_path).compile
+      end
+    end
+
+    def page_configs
+      @page_configs ||= PageConfigs.new(config_path)
+    end
+
+    def templates
+      @templates ||= Templates.new(templates_path)
+    end
+
+    def default_paths
+      @default_paths ||= DefaultPaths.new
+    end
+  end
+end

data/lib/prow/renderer.rb

@@ -0,0 +1,15 @@
+module Prow
+  class Renderer < Mustache
+    attr_accessor :templates, :page_name
+
+    def partial(name)
+      part = find_partial_template(name.to_s)
+      part && part.content
+    end
+
+    def find_partial_template(name)
+      return templates.page(page_name) if name == 'body'
+      templates.partial(name)
+    end
+  end
+end

data/lib/prow/template.rb

@@ -0,0 +1,27 @@
+module Prow
+  class Template < Struct.new(:path, :templates_path)
+    def type
+      path_parts.first
+    end
+
+    def name
+      name_path_parts.join('/')
+    end
+
+    def content
+      @content ||= File.read(path)
+    end
+
+    def partial_path
+      path.gsub(templates_path, '')
+    end
+
+    def path_parts
+      partial_path.split("/").select{|p| !p.empty? }
+    end
+
+    def name_path_parts
+      (path_parts - [type]).map {|e| e.split('.').first }
+    end
+  end
+end

data/lib/prow/templates.rb

@@ -0,0 +1,35 @@
+module Prow
+  class Templates < Struct.new(:path)
+    def layout(name='default')
+      template('layouts', name)
+    end
+
+    def page(name)
+      template('pages', name)
+    end
+
+    def partial(name)
+      partials.detect {|t| t.name == name}
+    end
+
+    def partials
+      collection.select {|template| template.type == 'partials' }
+    end
+
+    def template(type, name)
+      found = collection.detect { |template| template.type == type && template.name == name }
+      raise ArgumentError.new("#{type} #{name} not found") unless found
+      found
+    end
+
+    def collection
+      @collection ||= load
+    end
+
+    def load
+      Dir.glob("#{path}/**/*.mustache").map do |template_path|
+        Template.new(template_path, path)
+      end
+    end
+  end
+end

data/lib/prow/version.rb

@@ -0,0 +1,3 @@
+module Prow
+  VERSION = "0.1.0"
+end

data/lib/prow.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'forwardable'
+
+require 'mustache'
+
+require "prow/version"
+require "prow/default_paths"
+require "prow/page_configs"
+require "prow/template"
+require "prow/templates"
+require "prow/renderer"
+require "prow/page_compiler"
+require "prow/pages_compiler"

data/prow.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prow/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "prow"
+  spec.version       = Prow::VERSION
+  spec.authors       = ["Kane Baccigalupi"]
+  spec.email         = ["baccigalupi@gmail.com"]
+  spec.summary       = %q{Prow is a front end development framework, that can also server static websites}
+  spec.description   = %q{
+    Prow is solving the problem front-end developers have when they try to
+    start a project, and need a server mock to work with. It also solves the
+    problem of creating and serving a static HTML/CSS/JS that includes heavy
+    front-end development work.
+
+    Prow includes:
+      * Mustache to HTML file generation
+      * ShipdStyle compass plugin for getting easy responsive design widgets
+      * DeMedusa the slim, extensible, JS framework
+  }
+  spec.homepage      = "https://github.com/shipd/prow"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "shipd_style"
+  spec.add_dependency "mustache"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+end

data/spec/page_compiler_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Prow::PageCompiler do
+  let(:compiler)     { Prow::PageCompiler.new(name, config, templates, compile_dir) }
+  let(:full_configs) { JSON.parse(File.read(File.dirname(__FILE__) + "/support/pages.json"))['pages'] }
+  let(:config)       { full_configs[name]}
+  let(:name)         { 'index.html' }
+  let(:templates)    { Prow::Templates.new(File.dirname(__FILE__) + "/support/templates") }
+  let(:compile_dir)  { File.dirname(__FILE__) + "/support/public" }
+  let(:file_path)    { File.dirname(__FILE__) + "/support/public/index.html" }
+
+  before { File.delete(file_path) if File.exist?(file_path) }
+
+  let(:content) { File.read(file_path) }
+
+  it "should generate the right path" do
+    expect(compiler.path).to eq(file_path)
+  end
+
+  describe '#compile' do
+    it 'should generate a file at the path' do
+      compiler.compile
+      expect(File.exist?(file_path)).to be(true)
+    end
+
+    context 'with default layout' do
+      it "should have layout content" do
+        compiler.compile
+        expect(content).to include("DEFAULT LAYOUT")
+      end
+
+      it "should render data into the layout" do
+        compiler.compile
+        expect(content).to include("hello Prow")
+      end
+    end
+
+    context 'with specified layout' do
+      let(:name) { 'foo.html' }
+      let(:content) { File.read(compile_dir + "/foo.html") }
+
+      it "should have layout content" do
+        compiler.compile
+        expect(content).to include("FOO LAYOUT")
+      end
+    end
+
+    it "should render the body view" do
+      compiler.compile
+      expect(content).to include("Hello, home page!")
+    end
+
+    it "should render the partials called from the layout" do
+      compiler.compile
+      expect(content).to include("Hello Header World")
+    end
+
+    it "should render data in the body" do
+      compiler.compile
+      expect(content).to include("data sample")
+    end
+
+    it "should render partials called from the body" do
+      compiler.compile
+      expect(content).to include("Hello, it!")
+    end
+  end
+end

data/spec/pages_compiler_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe Prow::PagesCompiler do
+  let(:pages) { Prow::PagesCompiler.new(config_path, templates_path, public_path) }
+  let(:config_path)     { File.dirname(__FILE__) + "/support/pages.json" }
+  let(:templates_path)  { File.dirname(__FILE__) + "/support/templates" }
+  let(:public_path)     { File.dirname(__FILE__) + "/support/public" }
+
+  describe '#compile' do
+    before { pages.compile }
+
+    it "compiles entries in pages.json" do
+      expect(File.exist?(public_path + "/index.html")).to be(true)
+      expect(File.exist?(public_path + "/foo.html")).to be(true)
+    end
+
+    it "does not compile pages that are not included in pages.json" do
+      expect(File.exist?(public_path + "/bar.html")).to be(false)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require_relative "../lib/prow"
+
+#require 'nokogiri'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  #config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

data/spec/support/pages.json

@@ -0,0 +1,16 @@
+{
+  "pages": {
+    "index.html": {
+      "data": {
+        "title": "hello Prow",
+        "data_sample": "data sample"
+      }
+    },
+    "foo.html": {
+      "layout": "foo",
+      "data": {
+        "title": "go FOO!"
+      }
+    }
+  }
+}

data/spec/support/templates/index.mustache

@@ -0,0 +1,3 @@
+<h4>Hello, home page!</h4>
+{{data_sample}}
+{{> thingy/it}}

data/spec/support/templates/layouts/default.mustache

@@ -0,0 +1,14 @@
+<!DOCTYPE HTML>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>DEFAULT LAYOUT - {{title}}</title>
+  </head>
+  <body>
+    <div id="page" class='row'>
+      {{> header}}
+      {{> body}}
+    </div>
+  </body>
+</html>
+

data/spec/support/templates/layouts/foo.mustache

@@ -0,0 +1,14 @@
+<!DOCTYPE HTML>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>FOO LAYOUT - {{title}}</title>
+  </head>
+  <body>
+    <div id="page" class='row'>
+      {{> body}}
+    </div>
+  </body>
+</html>
+
+

data/spec/support/templates/pages/bar.mustache

@@ -0,0 +1 @@
+I am bar!

data/spec/support/templates/pages/foo.mustache

@@ -0,0 +1 @@
+I am foo!

data/spec/support/templates/pages/index.mustache

@@ -0,0 +1,4 @@
+<h4>Hello, home page!</h4>
+{{data_sample}}
+{{> things/it}}
+

data/spec/support/templates/partials/header.mustache

@@ -0,0 +1 @@
+<div id='header'>Hello Header World</div>

data/spec/support/templates/partials/things/it.mustache

@@ -0,0 +1 @@
+Hello, it!

data/spec/template_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe Prow::Template do
+  let(:template) { Prow::Template.new(path, templates_path) }
+  let(:path) { templates_path + "/layouts/default.mustache" }
+  let(:templates_path) { File.dirname(__FILE__) + "/support/templates" }
+
+  it "derives the type from the first directory name" do
+    expect(template.type).to eq("layouts")
+  end
+
+  it "returns lazy the template content" do
+    expect(template.instance_variable_get('@content')).to eq(nil)
+    expect(template.content).to eq(File.read(path))
+    expect(template.instance_variable_get('@content')).not_to eq(nil)
+  end
+
+  it "gets derives the name from the non-type end of the path" do
+    expect(template.name).to eq('default')
+  end
+
+  context 'when the path is nested' do
+    let(:path) { templates_path + "/partials/things/it.mustache" }
+
+    it "correctly gets the type" do
+      expect(template.type).to eq('partials')
+    end
+
+    it "correctly gets the name" do
+      expect(template.name).to eq("things/it")
+    end
+  end
+end

data/spec/templates_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe Prow::Templates do
+  let(:templates) { Prow::Templates.new(templates_path) }
+  let(:templates_path) { File.dirname(__FILE__) + "/support/templates" }
+
+  describe '#layout' do
+    it "returns layouts via name" do
+      layout = templates.layout('default')
+      expect(layout).to be_a(Prow::Template)
+      expect(layout.name).to eq('default')
+      expect(layout.content).to eq(File.read(templates_path + "/layouts/default.mustache"))
+    end
+
+    it "raises an error if named layout not found" do
+      expect { templates.layout('not-here') }.to raise_error
+    end
+
+    it "returns the default if no argument is passed in" do
+      expect(templates.layout).to eq(templates.layout('default'))
+    end
+  end
+
+  describe '#page' do
+    it "returns the right partial" do
+      expect(templates.page('index').name).to eq('index')
+    end
+  end
+
+  describe '#partials' do
+    it "returns all of the partials" do
+      expect(templates.partials.size).to eq(2)
+      expect(templates.partials.map(&:name)).to include("things/it", "header")
+    end
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: prow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kane Baccigalupi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shipd_style
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !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: "\n    Prow is solving the problem front-end developers have when they
+  try to\n    start a project, and need a server mock to work with. It also solves
+  the\n    problem of creating and serving a static HTML/CSS/JS that includes heavy\n
+  \   front-end development work.\n\n    Prow includes:\n      * Mustache to HTML
+  file generation\n      * ShipdStyle compass plugin for getting easy responsive design
+  widgets\n      * DeMedusa the slim, extensible, JS framework\n  "
+email:
+- baccigalupi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/prow.rb
+- lib/prow/default_paths.rb
+- lib/prow/page_compiler.rb
+- lib/prow/page_configs.rb
+- lib/prow/pages_compiler.rb
+- lib/prow/renderer.rb
+- lib/prow/template.rb
+- lib/prow/templates.rb
+- lib/prow/version.rb
+- prow.gemspec
+- spec/page_compiler_spec.rb
+- spec/pages_compiler_spec.rb
+- spec/spec_helper.rb
+- spec/support/pages.json
+- spec/support/public/.keep
+- spec/support/templates/index.mustache
+- spec/support/templates/layouts/default.mustache
+- spec/support/templates/layouts/foo.mustache
+- spec/support/templates/pages/bar.mustache
+- spec/support/templates/pages/foo.mustache
+- spec/support/templates/pages/index.mustache
+- spec/support/templates/partials/header.mustache
+- spec/support/templates/partials/things/it.mustache
+- spec/template_spec.rb
+- spec/templates_spec.rb
+homepage: https://github.com/shipd/prow
+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: Prow is a front end development framework, that can also server static websites
+test_files:
+- spec/page_compiler_spec.rb
+- spec/pages_compiler_spec.rb
+- spec/spec_helper.rb
+- spec/support/pages.json
+- spec/support/public/.keep
+- spec/support/templates/index.mustache
+- spec/support/templates/layouts/default.mustache
+- spec/support/templates/layouts/foo.mustache
+- spec/support/templates/pages/bar.mustache
+- spec/support/templates/pages/foo.mustache
+- spec/support/templates/pages/index.mustache
+- spec/support/templates/partials/header.mustache
+- spec/support/templates/partials/things/it.mustache
+- spec/template_spec.rb
+- spec/templates_spec.rb