gara 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53445248709d4bfdf4fa6ad8c7006c32618170d4
+  data.tar.gz: 7d9d015b2528d43df04cbebc8cc7bbb7be179b44
+SHA512:
+  metadata.gz: fc6ebab03af7e88c5be7626d057de79a98b081389c9f3f17310bdb75d37820766fa2a551a882621214bef07d2120e9528ba1933936df30f25470bfa5a95148a0
+  data.tar.gz: 174ac1bce72348f5b314e9ca580e80e0a87f3d8fedab14f711ae4472af5da7593acb85e45c7f7ff686c20941ffd5552a1331250dfbbfb0752a27ea619a1bebb8

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 ÆLOGICA | Build it better here.
+
+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,44 @@
+# Gara (柄)
+
+Provides a functional handle to nokogiri (鋸) for use in constructing html templates in plain Ruby as an alternative to Erb or HAML.
+
+## Usage
+
+Add this to your gemfile:
+
+    gem 'gara'
+
+Rename your application.html.erb to application.html.gara.
+
+Change your template to look like this.
+
+    html(lang: "en") {
+      head {
+        meta charset: 'utf-8'
+        meta name: 'viewport', content: "width=device-width, initial-scale=1.0"
+        title yield(:title)
+        stylesheet_link_tag "application", media: 'all', 'data-turbolinks-track' => true
+        javascript_include_tag 'application', 'data-turbolinks-track' => true
+        csrf_meta_tags
+      }
+      body {
+        yield
+        javascript_include_tag "application"
+      }
+    }
+
+Everything should work as you would expect.
+
+Set your editor syntax for .gara files to Ruby.
+
+## Background
+
+The motivation for this gem is simple.  The bondage of HAML is unnecessary.  The clutter of Erb is unsightly.
+
+I want to reduce cognative load, increase development speed and reduce errors.  I have observed much time is spent in view construction and many errors creep in here.  The seemingly minor irritation of having multiple syntaxes present in a single file contributes to problems.
+
+I want one syntax per file.  With a little imagination Ruby can map to HTML easily using its block structure.  This facilitates construction of an internal DSL that is "Just Ruby."
+
+Ultimately my objective with Gara is to get away from writing HTML directly and to use Gara as a substrate for building pages out of higher-level, reusable components which include not only DOM elements but also behaviors.  This is a key aspect of the AppExpress platform at [appexpress.io](http://appexpress.io).
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Gara'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/gara.rb

@@ -0,0 +1,8 @@
+module Gara
+  require 'gara/template/handler'
+  require 'gara/delegator'
+  require 'gara/html5_emitter'
+  if defined?(Rails)
+    ::ActionView::Template.register_template_handler :gara, Gara::Template::Handler
+  end
+end

data/lib/gara/delegator.rb

@@ -0,0 +1,27 @@
+module Gara
+
+  class Delegator
+    attr_accessor :emitter
+
+    def self.define_delegate(method_name, on: nil, to: nil)
+      on.module_eval <<-RUBY
+        def #{method_name}(*args)
+          #{to || "@gara_delegate"}.#{method_name}(*args) { yield if block_given? }
+        end
+      RUBY
+    end
+
+
+    def initialize(view_context, emitter = Html5Emitter.new)
+      @emitter = emitter
+      view_context.instance_variable_set(:@gara_delegate, emitter)
+      view_context.extend(emitter.registered_methods)
+      yield if block_given?
+    end
+
+    def to_html
+      emitter.to_html
+    end
+
+  end
+end

data/lib/gara/html5_emitter.rb

@@ -0,0 +1,59 @@
+require 'nokogiri'
+
+module Gara
+
+  HTML5_TAGS = [ :a, :abbr, :address, :area, :article, :aside, :audio,
+                 :b, :base, :bdi, :bdo, :blockquote, :body, :br, :button,
+                 :canvas, :caption, :cite, :code, :col, :colgroup,
+                 :data, :datalist, :dd, :del, :details, :dfn, :div, :dl, :dt,
+                 :em, :embed,
+                 :fieldset, :figcaption, :figure, :footer, :form,
+                 :h1, :h2, :h3, :h4, :h5, :h6, :head, :header, :hr, :html,
+                 :i, :iframe, :img, :input, :ins,
+                 :kbd, :keygen,
+                 :label, :legend, :li, :link,
+                 :main, :map, :mark, :math, :menu, :menuitem, :meta, :meter,
+                 :nav, :noscript,
+                 :object, :ol, :optgroup, :option, :output,
+                 :p, :param, :pre, :progress,
+                 :q,
+                 :rp, :rt, :ruby,
+                 :s, :samp, :script, :section, :select, :small, :source,
+                 :span, :strong, :style, :sub, :sup, :summary, :svg,
+                 :table, :tbody, :td, :textarea, :tfoot, :th, :thead, :time, :title,
+                 :tr, :track,
+                 :u, :ul,
+                 :var, :video,
+                 :wbr, :<<]
+
+  class Html5Emitter
+
+    module TagMethods
+      Gara::HTML5_TAGS.each do |tag|
+        Gara::Delegator.define_delegate tag, on: self
+      end
+    end
+
+    attr_accessor :target
+    def initialize
+      @doc = Nokogiri::HTML::DocumentFragment.parse("")
+      @gara_delegate = Nokogiri::HTML::Builder.with(@doc)
+      extend TagMethods
+    end
+
+    def registered_methods
+      return TagMethods
+    end
+
+    def to_html
+      nodes = @doc.children
+      if nodes.length.eql?(1) && nodes.first.name.eql?("html")
+        # necessary to include doctype - TODO: avoid calling to_html twice
+        Nokogiri::HTML::Document.parse( @doc.to_html ).to_html
+      else
+        @doc.to_html
+      end
+    end
+
+  end
+end

data/lib/gara/template/handler.rb

@@ -0,0 +1,14 @@
+module Gara
+  module Template
+    class Handler
+      def self.call(template)
+        new.call(template)
+      end
+
+      def call(template)
+        %Q(Gara::Delegator.new(self) { #{template.source} }.to_html)
+      end
+
+    end
+  end
+end

data/lib/gara/version.rb

@@ -0,0 +1,3 @@
+module Gara
+  VERSION = "0.1.1"
+end

data/lib/tasks/gara_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :gara do
+#   # Task goes here
+# end

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/hello_controller.rb

@@ -0,0 +1,4 @@
+class HelloController < ApplicationController
+  def show
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/hello/show.html.gara

@@ -0,0 +1,2 @@
+h1 "Hello"
+p 'Find me in app/views/hello/show.html.gara'

data/test/dummy/app/views/layouts/application.html.gara

@@ -0,0 +1,14 @@
+html(lang: "en") {
+  head {
+    meta charset: 'utf-8'
+    meta name: 'viewport', content: "width=device-width, initial-scale=1.0"
+    title yield(:title)
+    stylesheet_link_tag "application", media: 'all', 'data-turbolinks-track' => true
+    javascript_include_tag 'application', 'data-turbolinks-track' => true
+    csrf_meta_tags
+  }
+  body {
+    self << yield
+    javascript_include_tag "application"
+  }
+}

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "action_mailer/railtie" # should be able to remove this too, but no.
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "gara"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  # config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,82 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # `config.assets.precompile` has moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end