assets-publisher-for-hanami 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ade9157e66ba76611af970ee42bc61d400ae4dbf
+  data.tar.gz: fab9d08054b310d470ea9145242d05ff97ad93ed
+SHA512:
+  metadata.gz: 7c7fc21318151e0f491ad4a3c9e28a0e8fe19cbb40f15bae519cc5e18d3199f9e4e15af02b6bd4a0f7e059bbd6ff102a4d3b3d6e0bc57d03c92994f900c20538
+  data.tar.gz: c1642b1873b33193f38e61a6aa2e66d9bc084b0673ed691069c227dbc61c3645d46bebd0711760a7882e5aff3f6d965f4e4eaae23855792dc83878df6c79803f

data/.gitignore

@@ -0,0 +1,7 @@
+Gemfile.lock
+
+# Caches
+.sass-cache/
+
+# Simplecov test coverage report
+coverage/

data/.rspec

@@ -0,0 +1 @@
+--require 'spec-helper'

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+
+rvm:
+   - "2.0"
+   - "2.1"
+   - "2.2"
+
+before_install: gem install bundler
+
+script: bundle exec rspec
+
+git:
+   submodules: false

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rspec', require: false
+gem 'simplecov', require: false
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Martin Rubi
+
+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,257 @@
+# CabezaDeTermo::AssetsPublisher::Helper
+
+A framework to declare bundles of assets in your Hanami application, compile them into a public folder and add them to your template.
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/assets-publisher-for-hanami.svg)](https://badge.fury.io/rb/assets-publisher-for-hanami)
+[![Build Status](https://travis-ci.org/cabeza-de-termo/assets-publisher-for-hanami.svg?branch=master)](https://travis-ci.org/cabeza-de-termo/assets-publisher-for-hanami)
+[![Coverage Status](https://coveralls.io/repos/cabeza-de-termo/assets-publisher-for-hanami/badge.svg?branch=master&service=github)](https://coveralls.io/github/cabeza-de-termo/assets-publisher-for-hanami?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'assets-publisher-for-hanami', '~> 2.0'
+```
+
+And then execute:
+
+   $ bundle
+
+Or install it yourself as:
+
+   $ gem install assets-publisher-for-hanami
+
+## Usage
+
+To declare the asset bundles, add this required file to the application.rb file:
+
+```ruby
+require 'cabeza-de-termo/assets-publisher/helpers/helper'
+```
+
+and then add this to your Application class:
+
+```ruby
+module Web
+   class Application < Hanami::Application
+      configure do
+         ...
+
+         # Define the asset bundles.
+         # See https://github.com/cabeza-de-termo/assets-library-for-hanami for more details.      
+         CabezaDeTermo::Assets::Library.definition do
+            # Css
+            bundle :'bootstrap-css' do
+               include '/vendor/bootstrap/css/bootstrap.min.css' # include this asset in the bundle
+            end
+
+            # Js
+            bundle :jquery do
+               include '/vendor/jquery/jquery-1.11.3.min.js'
+            end
+
+            bundle :'bootstrap-js' do
+               require :jquery             # declare that this bundle depends on the :jquery bundle
+               include '/vendor/bootstrap/js/bootstrap.min.js'
+            end
+         end
+
+         # Configure the AssetsPublisher.
+         CabezaDeTermo::AssetsPublisher::Publisher.configure do
+            # Where we want to publish the compiled assets
+            destination_folder 'apps/web/public'
+
+            # Where to look for assets
+            sources << 'apps/web/assets'
+
+            # Optional, true by default.
+            add_timestamps_to_published_assets true
+
+            # Optionally uncomment to define custom compilers. You can also use :command_line_compiler
+            # stylesheets_compiler { CustomCssCompiler.new }
+            # javascripts_compiler { CustomJsCompiler.new }
+         end
+
+         ...
+      end
+   end
+end
+```
+
+To define the assets to be included in the layout, you can add these methods to your Web::Views::ApplicationLayout class:
+
+```ruby
+module Web
+   module Views
+      class ApplicationLayout
+         ...
+         # Define the stylesheet for this layout
+         def layout_stylesheets(assets_collector)
+            assets_collector.require :'bootstrap-css'          # include the bundle :'bootstrap-css'
+            assets_collector.include 'layout/layout.css.scss'  # include the asset layout.css.scss'
+         end
+
+         # Define the javascripts for this layout
+         def layout_javascripts(assets_collector)
+            assets_collector.require :'bootstrap-js'
+         end
+         ...
+      end
+   end
+end
+```
+
+To define the assets to be included in the view, you can add these methods to your Web::Views::SomeView class:
+
+```ruby
+module Web::Views::LandingPage
+   class Index
+      include Web::View
+
+      # Define the stylesheet for this view
+      def view_stylesheets(assets_collector)
+         assets_collector.include 'landing-page/landing-page.css.scss'
+      end
+
+      # Define the javascripts for this view
+      def view_javascripts(assets_collector)
+         assets_collector.include 'landing-page/landing-page.js'
+      end
+   end
+end
+```
+
+To collect the assets, add the AssetsPublisher::Helper to your ApplicationLayout:
+
+```ruby
+module Web
+   module Views
+      class ApplicationLayout
+         include Web::Layout
+         include CabezaDeTermo::AssetsPublisher::Helper
+
+            ...
+      end
+   end
+end
+```
+
+and then use the assets_publisher from your layout template:
+
+```ruby
+doctype html
+html
+   head
+      meta charset="UTF-8"
+      meta name="viewport" content="width=device-width, initial-scale=1"
+
+      / This will collect, publish and include all your stylesheets required by your layout and view
+      == assets_publisher.stylesheets_for self
+
+   body
+      ...
+
+      / This will collect, publish and include all your javascripts required by your layout and view
+      == assets_publisher.javascripts_for self
+```
+## Using custom assets compilers
+
+By default, Publisher uses a TiltCompiler to compile the assets. But you can change that to use a custom one.
+
+If you compile the assets by invoking a command line, there is a `command_line_compiler` you can use. In this example we configure the Publisher to use [lesscss](http://lesscss.org/usage/#command-line-usage-command-line-usage) to compile stylesheets and [uglifyjs](https://github.com/mishoo/UglifyJS2) to compile the javascripts. For this to work you must first install those tools of course.
+
+```ruby
+CabezaDeTermo::AssetsPublisher::Publisher.configure do
+   ...
+
+	stylesheets_compiler {
+		command_line_compiler do |compiler, compilation_job|
+			files_list = compilation_job.source_filenames.join(' ')
+			include_folders = compilation_job.source_folders.join(';')
+
+			compiler.command_line "lessc",
+				"--include-path=#{include_folders}", 
+				"--compress",
+				files_list, 
+				compilation_job.destination_filename
+		end
+	}
+
+   javascripts_compiler {
+      command_line_compiler do |compiler, compilation_job|
+         files_list = compilation_job.source_filenames.join(' ')
+         compiler.command_line 'uglifyjs', files_list, '--output', compilation_job.destination_filename
+      end
+   }
+
+   ...
+end
+```
+
+If you need to write your own compiler, create a class that inherits from [CabezaDeTermo::AssetsPublisher::Compiler](lib/cabeza-de-termo/assets-publisher/compilers/compiler.rb)
+
+```ruby
+require 'cabeza-de-termo/assets-publisher/compilers/compiler'
+
+class CustomCompiler < CabezaDeTermo::AssetsPublisher::Compiler
+   def compile_assets()
+      # you can access which files to compile with 
+      compilation_job.source_filenames
+      
+      # you can access which file to compile to with 
+      compilation_job.destination_filename
+      
+      # you can access the assets source folders with 
+      compilation_job.source_folders
+
+      # do compile the assets
+      ...
+   end
+end
+```
+
+and then configure Publisher to use your custom compiler
+
+```ruby
+CabezaDeTermo::AssetsPublisher::Publisher.configure do
+   ...
+   stylesheets_compiler { CustomCompiler.new }
+
+   # and/or
+
+   javascripts_compiler { CustomCompiler.new }
+   ...
+end
+```
+
+## See also
+
+* [**Hanami framework**](http://hanamirb.org/) - A complete web framework for Ruby.
+* [**CabezaDeTermo::Assets::Library**](https://github.com/cabeza-de-termo/assets-library-for-hanami) - A framework to declare bundles of assets in your Hanami application and collect them resolving the dependencies.
+
+## Running the tests
+
+- `bundle install`
+- `bundle exec rspec`
+
+## Roadmap for v2.1
+
+- Allow to define different compiling strategies:
+   - One compiled file per asset (for development)
+   - Maybe one compiled file per Action?
+   - One compiled file per application (for production)
+
+## Roadmap for v2.2
+
+- Allow the assets_publisher to publish other asset types (images and fonts)
+
+## Contributing
+
+1. Fork it ( https://github.com/cabeza-de-termo/assets-publisher-for-hanami/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"
+require "rspec/core/rake_task"

data/assets-publisher-for-hanami.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cabeza-de-termo/assets-publisher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "assets-publisher-for-hanami"
+  spec.version       = CabezaDeTermo::AssetsPublisher::Publisher::VERSION
+  spec.authors       = ["Martin Rubi"]
+  spec.email         = ["martinrubi@gmail.com"]
+
+  spec.summary       = %q{Framework to define and publish assets on your Hanami application.}
+  spec.description   = %q{Framework to define and publish assets on your Hanami application.}
+  spec.homepage      = "https://github.com/cabeza-de-termo/assets-publisher-for-hanami"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_dependency "cdt-utilities", "~> 0.3"
+  spec.add_dependency "assets-library-for-hanami", "~> 3.0"
+  spec.add_dependency "tilt", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "sass"
+  spec.add_development_dependency "coffee-script"
+  spec.add_development_dependency "therubyracer"
+end

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/cabeza-de-termo/assets-publisher/assets/asset.rb

@@ -0,0 +1,81 @@
+require 'cabeza-de-termo/assets-publisher/locations/location'
+
+require_relative 'types/stylesheet-type'
+require_relative 'types/javascript-type'
+
+module CabezaDeTermo
+	module AssetsPublisher
+		# An assets to be included in a template.
+		class Asset
+			# Answer a new asset on the asset_uri.
+			def self.on_uri(asset_type, asset_uri)
+				new(asset_type, asset_uri, Location.from(asset_uri))
+			end
+
+			# Initialize the instance.
+			def initialize(asset_type, asset_uri, location)
+				@uri = Pathname.new(asset_uri)
+				@type = asset_type
+				@location = location
+				@real_path = nil
+				@uri_parameters = nil
+			end
+
+			# Answer the asset uri.
+			def uri()
+				@uri
+			end
+
+			# Answer the asset uri with optional parameters
+			def uri_with_parameters()
+				return uri.to_s if uri_parameters.nil?
+
+				uri.to_s + '?' + URI.escape(uri_parameters)
+			end
+
+			# Answer the asset type
+			def type()
+				@type
+			end
+
+			# Answer the location of the asset
+			def location()
+				@location
+			end
+
+			# Answer the file path of the asset uri.
+			def real_path()
+				@real_path ||= location.real_path_of(uri)
+			end
+
+			def uri_parameters()
+				@uri_parameters
+			end
+
+			def set_uri_parameters(string)
+				@uri_parameters = string
+				self
+			end
+
+			# Answer the html to include this asset in a template
+			def html()
+				type.html_for uri_with_parameters
+			end
+
+			def validate_real_path()
+				raise_asset_not_found_error unless real_path.exist?
+			end
+
+			def modification_time()
+				return :not_found unless real_path.exist?
+				real_path.mtime
+			end
+
+			protected
+
+			def raise_asset_not_found_error()
+				raise AssetNotFoundError.new(uri)
+			end
+		end
+	end
+end