craftsman 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d85ef98c37213ef3309d659b66e01626bfed19a
+  data.tar.gz: b2e1aa719efe68d2275ca9cc03da65c86d76ee41
+SHA512:
+  metadata.gz: 30b4bf152a7047549e5bf59693c190c3dd57afbb9138da91467482f3b21b1bd4f6944ae17e90a422b9ad13109d321511b94c40514ba1321e8358dfc5d4a4bfda
+  data.tar.gz: a7e43f7dc49b6e20c7f1c406a0196af06e0b95e393ec9a259fc23a2f5dbb1bbf4e823a7582c898a2ff94f25ab480632279124067ff7b9521b94d4671c0a75fb0

data/.gitignore

@@ -0,0 +1,22 @@
+*.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

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+script: rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 agate
+
+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,31 @@
+# Craftsman
+
+A set of helpers for building inline template. (Currently, only support haml)
+
+[![Build Status](https://travis-ci.org/agate/craftsman.svg)](https://travis-ci.org/agate/craftsman)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'craftsman'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install craftsman
+
+## Usage
+
+See code in spec directory for more information.
+
+## Contributing
+
+1. Fork it ( https://github.com/agate/craftsman/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/craftsman.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'craftsman/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "craftsman"
+  spec.version       = Craftsman::VERSION
+  spec.authors       = ["agate"]
+  spec.email         = ["agate.hao@gmail.com"]
+  spec.summary       = %q{A set of helpers for building inline template.}
+  spec.description   = %q{Currently, only support haml.}
+  spec.homepage      = "https://github.com/agate/craftsman"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.1"
+end

data/lib/craftsman.rb

@@ -0,0 +1,14 @@
+require "craftsman/version"
+
+module Craftsman
+  def self.paint(package_class, package_id)
+    package = package_class.new(package_id)
+    Renderer.new(package).render
+  end
+end
+
+require "craftsman/package"
+require "craftsman/renderer"
+require "craftsman/decorator/base"
+require "craftsman/decorator/helper"
+require "craftsman/decorator/annotation"

data/lib/craftsman/decorator/annotation.rb

@@ -0,0 +1,12 @@
+module Craftsman::Decorator
+  class Annotation < Base
+    REGEX = /^\/\/@require\s+(.*)\s*$/
+
+    def process(content)
+      content.gsub(REGEX) do |m|
+        target = m.match(REGEX)[1]
+        build_filter(target)
+      end
+    end
+  end
+end

data/lib/craftsman/decorator/base.rb

@@ -0,0 +1,54 @@
+module Craftsman::Decorator
+  class Base
+    FILTER_EXT_MAPPING = {
+      'js' => 'javascript',
+      'rb' => 'ruby',
+      'md' => 'markdown',
+    }
+
+    def initialize(package)
+      @package = package
+    end
+
+    def process(content)
+      raise 'need be implemented'
+    end
+
+    def self.process(package, content)
+      self.new(package).process(content)
+    end
+
+    private
+
+    def build_filter(target)
+      target_ext = target.match(/([^.]+)$/)[1]
+      filter_name = FILTER_EXT_MAPPING[target_ext] || target_ext
+
+      target_content = @package.get(target)
+
+      filter = <<FILTER.strip
+:#{filter_name}
+#{append_indent(target_content)}
+FILTER
+
+      if ['js', 'coffee'].include? target_ext
+        filter = <<FILTER.strip
+- content_for :javascripts do
+#{append_indent(filter)}
+FILTER
+      end
+
+      <<FILTER
+///////////// #{target} /////////////
+#{filter}
+
+FILTER
+    end
+
+    def append_indent(str)
+      str.lines.map do |l|
+        "  #{l}"
+      end.join
+    end
+  end
+end

data/lib/craftsman/decorator/helper.rb

@@ -0,0 +1,17 @@
+module Craftsman::Decorator
+  class Helper < Base
+    def process(content)
+      helper_targets.map do |t|
+        build_filter t
+      end.join + content
+    end
+
+    private
+
+    def helper_targets
+      @package.targets.select do |t|
+        t.match(/^helpers\/.*rb$/)
+      end
+    end
+  end
+end

data/lib/craftsman/package.rb

@@ -0,0 +1,18 @@
+# you need to implement your own Package class
+# which is extended from "Craftsman::Package"
+class Craftsman::Package
+  def initialize(id)
+    @id = id
+  end
+
+  # return: content of target(file)
+  def get(target)
+    raise 'needs to be implemented'
+  end
+
+  # return: string array of targets(files)
+  #         in this package
+  def targets
+    raise 'needs to be implemented'
+  end
+end

data/lib/craftsman/renderer.rb

@@ -0,0 +1,18 @@
+class Craftsman::Renderer
+  def initialize(package)
+    @package = package
+  end
+
+  def render
+    output = @package.get("index.html.haml")
+
+    [
+      ::Craftsman::Decorator::Annotation,
+      ::Craftsman::Decorator::Helper
+    ].each do |klass|
+      output = klass.process(@package, output)
+    end
+
+    output
+  end
+end

data/lib/craftsman/version.rb

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

data/spec/craftsman_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Craftsman do
+  it "can paint correctly" do
+    output = Craftsman.paint(CustomPackage, 'package_a')
+    expect(output).to eq(<<OUTPUT)
+///////////// helpers/main.rb /////////////
+:ruby
+  def display_date
+    Time.now.strftime("%Y-%m-%d")
+  end
+
+///////////// javascripts/foo.js /////////////
+- content_for :javascripts do
+  :javascript
+    var foo = 'hello';
+
+
+///////////// javascripts/bar.coffee /////////////
+- content_for :javascripts do
+  :coffee
+    console.log foo
+
+
+///////////// stylesheets/foo.sass /////////////
+:sass
+  table
+    td:hover
+      background-color: green
+
+
+= display_date
+
+%table
+  %thead
+    %tr
+      %th Key
+      %th Value
+  %tbody
+    %tr
+      %td a
+      %td 1
+    %tr
+      %td b
+      %td 2
+    %tr
+      %td c
+      %td 3
+OUTPUT
+  end
+end

data/spec/custom_package.rb

@@ -0,0 +1,20 @@
+class CustomPackage < Craftsman::Package
+  DIR = File.expand_path('../resources', __FILE__)
+
+  def initialize(id)
+    super(id)
+    @dir = "#{DIR}/#{@id}"
+  end
+
+  def get(target)
+    File.read("#{@dir}/#{target}")
+  end
+
+  def targets
+    Dir["#{@dir}/**/*"].reject do |f|
+      File.directory? f
+    end.map do |f|
+      f.sub("#{@dir}/", '')
+    end
+  end
+end

data/spec/package_spec.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe :package do
+  before :all do
+    @package = CustomPackage.new("package_a")
+  end
+
+  it "should return all the targets" do
+    expect(@package.targets.size).to eq(5)
+  end
+
+  it "can get target's content" do
+    file = File.expand_path('../resources/package_a/helpers/main.rb', __FILE__)
+    content = File.read(file)
+    expect(@package.get('helpers/main.rb')).to eq(content)
+  end
+end

data/spec/resources/package_a/helpers/main.rb

@@ -0,0 +1,3 @@
+def display_date
+  Time.now.strftime("%Y-%m-%d")
+end

data/spec/resources/package_a/index.html.haml

@@ -0,0 +1,21 @@
+//@require javascripts/foo.js
+//@require javascripts/bar.coffee
+//@require stylesheets/foo.sass
+
+= display_date
+
+%table
+  %thead
+    %tr
+      %th Key
+      %th Value
+  %tbody
+    %tr
+      %td a
+      %td 1
+    %tr
+      %td b
+      %td 2
+    %tr
+      %td c
+      %td 3

data/spec/resources/package_a/javascripts/bar.coffee

@@ -0,0 +1 @@
+console.log foo

data/spec/resources/package_a/javascripts/foo.js

@@ -0,0 +1 @@
+var foo = 'hello';

data/spec/resources/package_a/stylesheets/foo.sass

@@ -0,0 +1,3 @@
+table
+  td:hover
+    background-color: green

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'craftsman'
+require File.expand_path('../custom_package', __FILE__)

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: craftsman
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- agate
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-24 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Currently, only support haml.
+email:
+- agate.hao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- craftsman.gemspec
+- lib/craftsman.rb
+- lib/craftsman/decorator/annotation.rb
+- lib/craftsman/decorator/base.rb
+- lib/craftsman/decorator/helper.rb
+- lib/craftsman/package.rb
+- lib/craftsman/renderer.rb
+- lib/craftsman/version.rb
+- spec/craftsman_spec.rb
+- spec/custom_package.rb
+- spec/package_spec.rb
+- spec/resources/package_a/helpers/main.rb
+- spec/resources/package_a/index.html.haml
+- spec/resources/package_a/javascripts/bar.coffee
+- spec/resources/package_a/javascripts/foo.js
+- spec/resources/package_a/stylesheets/foo.sass
+- spec/spec_helper.rb
+homepage: https://github.com/agate/craftsman
+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: A set of helpers for building inline template.
+test_files:
+- spec/craftsman_spec.rb
+- spec/custom_package.rb
+- spec/package_spec.rb
+- spec/resources/package_a/helpers/main.rb
+- spec/resources/package_a/index.html.haml
+- spec/resources/package_a/javascripts/bar.coffee
+- spec/resources/package_a/javascripts/foo.js
+- spec/resources/package_a/stylesheets/foo.sass
+- spec/spec_helper.rb