shipmonk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 803e1d39ec02e4b25f343cd7de3d1910be53c1c0
+  data.tar.gz: 7982556478a5660b28d4bf03dc3e058676d9f627
+SHA512:
+  metadata.gz: e116a29e63a37d8a29d72384dd55ffee826695f8717cfffe811ad45ced9b2dff20bae12aa32e7ac3be48d77c655f3b530c4ba22f7a94b48624589d51aa15a40a
+  data.tar.gz: fe097f38e06eaadd97233107619d05e5b4506800b16c09f182d6bfbfb9748321f1dbfa32be1327b2eb2aa53ee5450d2f3a1b2084be33867bd608b42dfe9b02d5

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jason Wall
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jason Wall
+
+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,28 @@
+shipmonk
+========
+
+Environment for prototyping, developing, and maintaining static websites
+
+I do this quite frequently: I'll just want to play around with some HTML/CSS/Javascript, either for an idea I have for a website design, a CSS attribute I've never seen before that I want to try out, or a Javascript library I want to play aroudn with. Regardless, I always end up with the same problem.
+
+* I want a local server I can start up quickly, like as in as soon as I create the project
+* I want to use HAML because HTML is irritating after using HAML
+* I hate repeating myself for things like menus
+
+I came up with the idea for shipmonk to be a dev-happy static website prototyping environment that can then generate html files that can be transferred to a static host server via FTP or SSH or whatever you want to use to deploy.
+
+I've since expanded on the vision behind what I want Shipmonk to be. Picture a website development environment that can take a website from a prototype you do for a client, to a "compiled" version of your prototype to be that client's website, all easily maintainable through a dynamic templating environment that you can then recompile and redistribute to the host site. Then if the client's needs grow, they can graduate to a user friendly CMS system all the while the entire codebase never has to switch frameworks.
+
+Below is a list of features I want to see eventually added to Shipmonk, because right now the current feature set is quite small. It's just a basic library I use myself to quickly whip up proof of concept websites.
+
+TODO
+==========
+* A CLI command to generate a new shipmonk projects - our `rails new` equivalent.
+* A CLI command for compiling the website into HTML - I think right now I just use a local ruby script to do this on a project per project basis
+* A CLI command for starting the server on an agreed upon port - our `rails server` equivalent.
+* The templating engine needs beefing up, for supporting and selecting layouts through a convention over configuration approach
+* Supporting multiple templating engines beyond just HAML. ERB, Markdown, or whatever else someone may want to add support for.
+* A CMS UI
+* Having the website that's hosted by the internal server support being run under a Rails Engine
+* Having the CMS UI run under a Rails Engine
+* A cool logo/mascot that involves a ship (old school sailing ship) or just the crowsnest, a Chipmunk dressed as a monk with possibly some pirate elements woven into it.

data/Rakefile

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

data/bin/shipmonk

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'shipmonk/cli'
+
+Shipmonk::CLI.start(ARGV)

data/lib/shipmonk.rb

@@ -0,0 +1,8 @@
+require "shipmonk/version"
+require 'pathname'
+
+module Shipmonk
+  def self.root
+    @root ||= Pathname.new File.expand_path(Dir.pwd)
+  end
+end

data/lib/shipmonk/cli.rb

@@ -0,0 +1,38 @@
+require 'thor'
+
+module Shipmonk
+  class CLI < Thor
+    include Thor::Actions
+    desc 'new <name>', 'Create a new Shipmonk site'
+
+    def new(site_name)
+      site_path = File.expand_path site_name, Dir.pwd
+      abort "Site already exists, choose another name or delete the existing site." if Dir.exists? site_path
+      create_site site_path
+    end
+
+    desc 'server', 'Start up a local server that hosts your site.'
+
+    def server(*args)
+      require 'shipmonk/server'
+      # get rid of 'server' in the args list
+      # otherwise :config in default_options gets set to 'server'
+      ARGV.shift
+      Shipmonk::Server.new.start
+    end
+
+    def self.source_root
+      File.expand_path '../shipmonk/default', File.dirname(__FILE__)
+    end
+
+  private
+
+    def create_site(site_path)
+      self.destination_root = site_path
+      Dir.mkdir destination_root
+      copy_file 'config.ru'
+      copy_file 'Gemfile'
+      directory 'src'
+    end
+  end
+end

data/lib/shipmonk/default/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gem 'shipmonk'

data/lib/shipmonk/default/config.ru

@@ -0,0 +1,3 @@
+require 'shipmonk'
+
+run Shipmonk::Server.new

data/lib/shipmonk/default/src/index.html.haml

@@ -0,0 +1,11 @@
+!!! 5
+%html
+    %head
+        %title New Shipmonk Site
+    %body
+        %h1 Welcome!
+
+        %p
+            You are successfully serving your new Shipmonk site. Just start editing
+            %code src/index.html.haml
+            to watch the magic happen.

data/lib/shipmonk/server.rb

@@ -0,0 +1,17 @@
+require 'rack'
+
+class Shipmonk::Server < Rack::Server
+  def middleware
+    middlewares = []
+    middlewares << [Rack::Static, { urls: ['/images', '/styles', '/scripts'], root: 'public' }]
+    middlewares << [Rack::Reloader]
+    Hash.new(middlewares)
+  end
+
+  def call(env)
+    responder = RequestResponder.new Rack::Request.new(env)
+    responder.respond
+  end
+end
+
+require 'shipmonk/server/request_responder'

data/lib/shipmonk/server/request_responder.rb

@@ -0,0 +1,43 @@
+require 'haml'
+require 'shipmonk/view_context'
+
+class Shipmonk::Server::RequestResponder
+  attr_accessor :request
+
+  def initialize(request)
+    @request = request
+  end
+
+  def respond
+    if template_source_file.exist?
+      content = compile_haml template_source_file
+      Rack::Response.new.finish do |response|
+        response['content-type'] = 'text/html'
+        response.status = 200
+        response.write content
+      end
+    else
+      Rack::Response.new.finish do |response|
+        response['content-type'] = 'text/plain'
+        response.status = 404
+        response.write "404ed!\n"
+        response.write "file not found: #{request.path_info}\n"
+      end
+    end
+  end
+
+  def compile_haml(file, haml_options = {})
+    content = File.read file
+    engine = Haml::Engine.new(content, haml_options)
+    engine.render Shipmonk::ViewContext.new
+  end
+
+  def template_source_file
+    @template_source_file ||= Shipmonk.root.join 'src', case request.path_info
+      when '/' then 'index.html.haml'
+      when /\/(\w+)$/, /\/(.+).html$/ then "#{$1}.html.haml"
+      else
+        request.path_info
+      end
+  end
+end

data/lib/shipmonk/version.rb

@@ -0,0 +1,3 @@
+module Shipmonk
+  VERSION = "0.0.1"
+end

data/lib/shipmonk/view_context.rb

@@ -0,0 +1,19 @@
+module Shipmonk
+  class ViewContext
+    def livereload_tag
+      %Q{<script type="text/javascript">
+            var tag = '<script type="text/javascript" src="http://thejayvm.ca/livereload.js?host=';
+            tag += location.hostname;
+            tag += '"></scr';
+            tag += 'ipt>';
+            document.write(tag);
+        </script>
+      } unless ENV.fetch('SHIPMONK_ENV', :local).to_sym == :live
+    end
+
+    def include_file(partial, locals = {})
+      content = File.read(File.expand_path "src/_#{partial.to_s}.html.haml")
+      Haml::Engine.new(content).render Object.new, locals
+    end
+  end
+end

data/shipmonk.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shipmonk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shipmonk"
+  spec.version       = Shipmonk::VERSION
+  spec.authors       = ["Jason Wall"]
+  spec.email         = ["javajo@gmail.com"]
+  spec.description   = %q{Environment for prototyping, developing, and maintaining static websites}
+  spec.summary       = <<-MD
+    Prototype a website with dynamic templating. Compile it. Deploy it to a static host.
+  MD
+  spec.homepage      = "https://github.com/thejayvm/shipmonk"
+  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_runtime_dependency "haml", '~> 4.0', '>= 4.0.3'
+  spec.add_runtime_dependency "rack", '~> 1.5', '>= 1.5.2'
+  spec.add_runtime_dependency "thor", '~> 0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", '~> 0'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: shipmonk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jason Wall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.3
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  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.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: Environment for prototyping, developing, and maintaining static websites
+email:
+- javajo@gmail.com
+executables:
+- shipmonk
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/shipmonk
+- lib/shipmonk.rb
+- lib/shipmonk/cli.rb
+- lib/shipmonk/default/Gemfile
+- lib/shipmonk/default/config.ru
+- lib/shipmonk/default/src/index.html.haml
+- lib/shipmonk/server.rb
+- lib/shipmonk/server/request_responder.rb
+- lib/shipmonk/version.rb
+- lib/shipmonk/view_context.rb
+- shipmonk.gemspec
+homepage: https://github.com/thejayvm/shipmonk
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Prototype a website with dynamic templating. Compile it. Deploy it to a static
+  host.
+test_files: []