pubba 0.6.0 → 0.7.0

data/CHANGES

@@ -1,5 +1,12 @@
 master
 
+  * Conceptual change from Sinatra extension to generic library
+  * Namespace changed from Sinatra::Pubba to Pubba
+  * Change to configuration implementation
+  * Pubba::Site.configure called in Pubba.configure
+  * Removed automatic monitoring. Detailed how to set this up as a Rake task in the README
+  * Added ability to set asset host(s)
+  * Javascript and Stylesheet folders are configurable. Defaults to 'js' and 'css'.
 
 0.6.0
 

data/README.md

@@ -1,6 +1,6 @@
 # pubba
 
-pubba is a Sinatra extension designed to help you manage your site. It uses [Sprockets](https://github.com/sstephenson/sprockets) for packaging assets and [R18n](http://r18n.rubyforge.org/) for internationalization/localization. I use R18n as a central location for default text, the internationalization functionality is a nice bonus in the event the application needs to move in that direction.
+pubba is a library designed to help you manage your site. It uses [Sprockets](https://github.com/sstephenson/sprockets) for packaging assets and [R18n](http://r18n.rubyforge.org/) for internationalization/localization. I use R18n as a central location for default text, the internationalization functionality is a nice bonus in the event the application needs to move in that direction.
 
 # Note
 
@@ -31,26 +31,45 @@ In addition, when using R18n, pubba gives you access through a single page objec
 
 More details on these later, but here are the configuration options:
 
-**Note: __settings.root__ refers to \<ProjectRoot\>/app/**
+### A couple of things to note:
 
-### Location of the config file. REQUIRED
-    set :pubba_config, File.join(settings.root, '..', 'config', 'pubba.yml')
+* __settings.root__ refers to &lt;ProjectRoot&gt;/app/**
+* Images are not processed and should be stored in your public directory
 
-### Location of the public_folder. REQUIRED
-    set :public_folder, File.join(settings.root, '..', 'public')
 
-### Location of the asset_folder. REQUIRED
-    set :asset_folder, File.join(settings.root, 'assets')
+### Sample configuration
+    Pubba.configure do |p|
+      # REQUIRED.
+      p.config_file   = File.join( File.dirname(__FILE__), 'pubba.yml')
 
-### Asset handler. Defaults to [Sprockets](https://github.com/sstephenson/sprockets)
-Right now there's only support for Sprockets, but leaving the option open for others.
-    set :asset_handler, Sinatra::Pubba::Assets::SprocketsHandler
+      # REQUIRED.
+      p.asset_folder  = File.join(settings.root, 'assets')
 
-### Location of the [R18n](http://r18n.rubyforge.org/) folder. OPTIONAL
-    set :r18n_folder, File.join(settings.root, 'i18n')
+      # REQUIRED.
+      p.public_folder = settings.public_folder
 
-### Locale. Defaults to 'en'
-    set :r18n_locale, 'en'
+      # OPTIONAL. Defaults to 'css'
+      p.style_folder = 'css'
+
+      # OPTIONAL. Defaults to 'js'
+      p.script_folder = 'js'
+
+      # OPTIONAL. Defaults to Sprockets: https://github.com/sstephenson/sprockets/
+      p.asset_handler = Pubba::Assets::SprocketsHandler
+
+      # OPTIONAL. Defaults to YUI Compressor: https://github.com/sstephenson/ruby-yui-compressor/
+      p.asset_minifier = Pubba::Assets::YUIMinifier
+
+      # OPTIONAL. Asset hosts (value must be a Proc)
+      p.asset_host = -> asset { [  "http://assets.mysite.com#{asset}",
+                                   "http://assets1.mysite.com#{asset}"].sample }
+
+      # OPTIONAL.
+      p.r18n_folder   = File.join(settings.root, 'i18n')
+
+      # OPTIONAL.
+      p.r18n_locale, 'en'
+    end
 
 
 
@@ -62,17 +81,18 @@ First things first, you'll want to install the gem:
 
 Then you'll want to use it in your app like so:
 
-    require 'sinatra/pubba'
+    require 'pubba'
 
     class App < Sinatra::Application
       # Settings as described above
-      set :asset_folder, File.join(settings.root, 'assets')
       set :public_folder, File.join(settings.root, '..', 'public')
-      set :r18n_folder, File.join(settings.root, 'i18n')
 
-      set :pubba_config, File.join(settings.root, '..', 'config', 'pubba.yml')
-
-      register Sinatra::Pubba
+      Pubba.configure do |p|
+        p.config_file   = File.join(settings.root, '..', 'config', 'pubba.yml')
+        p.public_folder = settings.public_folder
+        p.asset_folder  = File.join(settings.root, 'assets')
+        p.r18n_folder   = File.join(settings.root, 'i18n')
+      end
     end
 
 Next up is creating the all important __pubba.yml__ config file:
@@ -168,6 +188,30 @@ Again, using the above __pubba.yml__ configuration, if you are using the 'home'
     <script src="https://ajax.googleapis.com/ajax/libs/jqueryui/1.8.16/jquery-ui.min.js" type="text/javascript"></script>
     <script src="/js/home-body.js" type="text/javascript"></script>
 
+# Monitoring changes
+
+To monitor your assets directory to keep the public directory in sync, you'll need to create a rake task:
+
+    namespace :pubba do
+      desc 'Process the js and css assets then monitor for changes'
+      task :monitor do
+
+        # Require your app to configure Pubba
+        require_relative 'app/app'
+
+        require 'pubba/monitor'
+
+        # The monitor process will only run Site.process when it detects a
+        # change so we need to run it once to make sure the public directory
+        # is in sync.
+
+        puts ">> Processing assets..."
+        Pubba::Site.process
+
+        Pubba::Monitor.run
+      end
+    end
+
 # R18n
 
 If you're using R18n, you will need a translation file, here's a sample en.yml:
@@ -186,7 +230,7 @@ If you're using R18n, you will need a translation file, here's a sample en.yml:
 Take note of the __home__ section in both __pubba.yml__ and __en.yml__. If you have a route in your app that you want to use the __home__ defintions, do this:
 
     get '/' do
-      @page = Sinatra::Pubba::Site.page('home')
+      @page = Pubba::Site.page('home')
       slim :"aux/index"
     end
 
@@ -203,9 +247,10 @@ Notice that `title` is defined under the `home` section, but `home_link` is a to
 
 # Acknowledgement
 
-Huge thanks to my company, [Primedia](http://primedia.com) for encouraging open source contributions. This particular extension is obviously very new and hasn't hit a production site yet, but it will. I will post a list here as we migrate our applications from Rails to Sinatra.
+Huge thanks to my company, [Primedia](http://primedia.com) for encouraging open source contributions.
 
 # Contributors
 
 I highly value contributions and will happily list all those who submit accepted pull requests.
 
+[Chas Lemley](https://github.com/chaslemley) : YUI Compressor support

data/lib/pubba.rb

@@ -0,0 +1,42 @@
+require 'sinatra/base'
+require 'rack/statica_server'
+
+require_relative 'pubba/errors'
+require_relative 'pubba/site'
+require_relative 'pubba/html/helpers'
+
+module Pubba
+  class << self
+    attr_accessor :config_file, :public_folder
+    attr_accessor :style_folder, :script_folder
+    attr_accessor :asset_folder, :asset_host
+    attr_accessor :asset_handler, :asset_minifier
+    attr_accessor :r18n_folder, :r18n_locale
+
+    def configure
+      yield self
+      validate_settings
+      Site.configure
+    end
+
+    def set_defaults
+      @asset_handler  = Pubba::Assets::SprocketsHandler
+      @asset_minifier = Pubba::Assets::YUIMinifier
+      @script_folder  = 'js'
+      @style_folder   = 'css'
+    end
+
+    def validate_settings
+      missing_settings = []
+      missing_settings << ":public_folder has not been set!" unless Pubba.public_folder
+      missing_settings << ":asset_folder has not been set!" unless Pubba.asset_folder
+
+      if missing_settings.length > 0
+        messages = missing_settings.join("\n")
+        raise Pubba::ConfigurationError.new("Missing configuration options:\n#{messages}")
+      end
+    end
+  end
+end # Pubba
+
+Pubba.set_defaults

data/lib/pubba/assets/configuration.rb

@@ -0,0 +1,25 @@
+require 'psych'
+
+module Pubba
+  module Assets
+    class Configuration
+      attr_reader :yaml, :name, :disclaimer
+
+      def initialize(config_file)
+        @yaml = Psych.load_file(config_file)
+        @name = File.basename(config_file)
+        @disclaimer = "// This file is automatically generated from the contents\n// in #{name}\n//\n"
+      end
+
+      def global_config!
+        @global_config ||= (yaml.delete("global") || {})
+      end
+
+      def process
+        yaml.each do |page, config|
+          yield page, config
+        end
+      end
+    end # Configuration
+  end # Assets
+end # Pubba

data/lib/pubba/assets/handler.rb

@@ -0,0 +1,21 @@
+module Pubba
+  module Assets
+    class Handler
+      def self.asset(file)
+        raise NotImplementedError
+      end
+
+      def save_as(file)
+        raise NotImplementedError
+      end
+
+      def process(pattern, destination)
+        raise NotImplementedError
+      end
+
+      def build(name, type, ext, urls)
+        raise NotImplementedError
+      end
+    end # Handler
+  end # Assets
+end # Pubba

data/lib/pubba/assets/minifier.rb

@@ -0,0 +1,9 @@
+module Pubba
+  module Assets
+    class Minifier
+      def self.minify(folder, handler)
+        raise NotImplementedError
+      end
+    end # Compressor
+  end # Assets
+end # Pubba

data/lib/pubba/assets/sprockets_handler.rb

@@ -0,0 +1,53 @@
+require 'fileutils'
+require 'sprockets'
+require_relative 'handler'
+
+module Pubba
+  module Assets
+    class SprocketsHandler < Handler
+      def self.find(file)
+        SprocketsHandler.new(sprockets.find_asset(file))
+      end
+
+      def self.asset_paths(*paths)
+        paths.each do |path|
+          sprockets.append_path path
+        end
+      end
+
+      def self.sprockets
+        @sprockets ||= Sprockets::Environment.new()
+      end
+
+      def self.process(source, destination)
+        FileUtils.mkdir_p destination
+
+        Dir.glob("#{source}/*") do |file|
+          asset = find(file)
+          asset.save_as "#{destination}/#{File.basename(file)}"
+        end
+      end
+
+      def self.build(name, type, ext, urls)
+        content = urls.collect{|url| "//= require #{url}.#{ext}"}.compact.join("\n")
+        out_folder = File.join(Pubba.asset_folder, "out", ext)
+        FileUtils.mkdir_p out_folder
+        fname = File.join(out_folder, "#{name}-#{type}.#{ext}")
+        File.open(fname, 'w') do |f|
+          f.write Site.asset_configuration.disclaimer
+          f.write content
+        end
+      end
+
+      attr_reader :asset
+
+      def initialize(asset)
+        @asset = asset
+      end
+
+      def save_as(file)
+        asset.write_to(file)
+      end
+    end # SprocketsHandler
+  end # Assets
+end # Pubba

data/lib/pubba/assets/yui_minifier.rb

@@ -0,0 +1,26 @@
+require "yui/compressor"
+require_relative 'minifier'
+
+module Pubba
+  module Assets
+    class YUIMinifier < Minifier
+      def self.minify(folder, handler)
+        compressor = get_compressor(handler)
+        Dir.glob("#{folder}/*.*") do |file|
+          contents = File.read(file)
+          File.open(file, "w") {|f| f.write(compressor.compress(contents))}
+        end
+      end
+
+      private
+
+      def self.get_compressor(handler)
+        case handler
+          when :js then YUI::JavaScriptCompressor.new
+          when :css then YUI::CssCompressor.new
+          else raise ArgumentError, "minify handler must be one of [:js, :css]"
+        end
+      end
+    end # YUIMinifier
+  end # Assets
+end # Pubba

data/lib/pubba/errors.rb

@@ -0,0 +1,3 @@
+module Pubba
+  class ConfigurationError < StandardError; end
+end

data/lib/pubba/html/helpers.rb

@@ -0,0 +1,50 @@
+module Pubba
+  module HTML
+    module Helpers
+      def page_head_tags
+        process_tags(@page.head_tags)
+      end
+
+      def page_body_tags
+        process_tags(@page.body_tags)
+      end
+
+      def digest_url(url)
+        url.start_with?('http') ? url : Site.asset_host[::Statica.digest_url(url)]
+      end
+
+      private
+
+      def process_tags(tags)
+        array = []
+        tags.each do |tag|
+          t = tag.dup
+          set_url(type = t.delete(:tag), t)
+          array << tag_content(type, '', t)
+        end
+        array.join('')
+      end
+
+      def set_url(type, t)
+        if type == 'script'
+          t[:src] = digest_url(t[:src])
+        else
+          t[:href] = digest_url(t[:href])
+        end
+      end
+
+      def tag_content(tag, content, attrs={}, self_closing=false)
+        base = "<#{tag}#{tag_attrs(attrs)}"
+        self_closing ? "#{base}/>":"#{base}>#{content}</#{tag}>"
+      end
+
+      def tag_attrs(attrs)
+        return '' if attrs.empty?
+
+        return " " + attrs.keys.sort.collect do |k|
+          %|#{k}="#{attrs[k]}"|
+        end.join(' ')
+      end
+    end
+  end # HTML
+end # Pubba

data/lib/pubba/locale.rb

@@ -0,0 +1,16 @@
+require 'r18n-desktop'
+
+module Pubba
+  class Locale
+    include R18n::Helpers
+
+    R18n.from_env Pubba.r18n_folder, Pubba.r18n_locale
+
+    def get(category, name, *args)
+      res = t.send(category).send(name, *args)
+      res = t.send(name, *args) if R18n::Untranslated === res
+
+      R18n::Untranslated === res ? nil : res
+    end
+  end # Locale
+end # Pubba

data/lib/pubba/monitor.rb

@@ -0,0 +1,29 @@
+require 'fssm'
+
+module Pubba
+  module Monitor
+    extend self
+
+    def run
+      script_asset_folder = File.join(Pubba.asset_folder, Pubba.script_folder)
+      style_asset_folder = File.join(Pubba.asset_folder, Pubba.style_folder)
+
+      puts ">> Pubba is now monitoring:\n>>   #{script_asset_folder}\n>>   #{style_asset_folder}"
+      FSSM.monitor do
+        path script_asset_folder do
+          glob '**/*'
+          update {|base, relative, type| Site.process}
+          delete {|base, relative, type| Site.process}
+          create {|base, relative, type| Site.process}
+        end
+
+        path style_asset_folder do
+          glob '**/*'
+          update {|base, relative, type| Site.process}
+          delete {|base, relative, type| Site.process}
+          create {|base, relative, type| Site.process}
+        end
+      end
+    end
+  end # Monitor
+end # Pubba

data/lib/pubba/page.rb

@@ -0,0 +1,133 @@
+module Pubba
+  class Page
+    attr_accessor :name
+    attr_reader :assets, :head_tags, :body_tags
+
+    def initialize(name, global_configuration = {})
+      @name = name
+      @assets = {"styles" => {}, "scripts" => {}}
+      @head_tags = []
+      @body_tags = []
+
+      global_configuration["styles"].each do |key, value|
+          @assets["styles"][key] = value.dup
+      end
+
+      script_groups do |group|
+        @assets["scripts"][group] = global_configuration["scripts"][group] || []
+      end
+    end
+
+    def add_asset(type, section)
+      if type == "styles"
+         section.each do |section_name, hash|
+           hash.each do |key, value|
+            if key == "urls"
+              @assets[type][section_name][key] += value
+            else
+              @assets[type][section_name][key] = value
+            end
+          end
+        end
+      else
+        script_groups do |group|
+          @assets["scripts"][group] += section[group] if section[group]
+        end
+      end
+    end
+
+    def assetize
+      create_style_assets
+      create_script_assets
+    end
+
+    def tagify
+      style_groups do |group, hash|
+        style_urls(group) do |url|
+          add_style_tag(group, hash, url)
+        end
+      end
+
+      script_groups do |group|
+        script_urls(group) do |url|
+          add_script_tag(group, url)
+        end
+      end
+    end
+
+    def method_missing(meth, *args)
+      if Site.locale && (t = Site.locale.get(name, meth, *args))
+        return t
+      end
+      super
+    end
+
+    private
+
+    def process_scripts(array)
+      return [] if array.nil? || array.empty?
+
+      array.each{|ele| scripts << ele }
+    end
+
+    def create_style_assets
+      style_groups do |group, hash|
+        urls = []
+        style_urls(group) do |url|
+          next if url.start_with?("http")
+          urls << url
+        end
+        Pubba.asset_handler.build(name, group, "css", urls)
+      end
+    end
+
+    def create_script_assets
+      script_groups do |group|
+        urls = []
+        script_urls(group) do |url|
+          next if url.start_with?("http")
+          urls << url
+        end
+        Pubba.asset_handler.build(name, group, "js", urls)
+      end
+    end
+
+    def style_groups
+      @assets["styles"].each{|group, hash| yield group, hash }
+    end
+
+    def style_urls(group)
+      @assets["styles"][group]["urls"].each{|url| yield url }
+    end
+
+    def script_groups
+      ["head", "body"].each{|group| yield group }
+    end
+
+    def script_urls(group)
+      @assets["scripts"][group].each{|url| yield url }
+    end
+
+    def add_style_tag(group, hash, url)
+      h = { tag: 'link', type: 'text/css', rel: 'stylesheet' }
+      h[:media] = hash['media'] if hash['media']
+      h[:href]  = url.start_with?("http") ? url : "/#{Pubba.style_folder}/#{name}-#{group}.css"
+
+      maybe_add_tag(@head_tags, h, :href)
+    end
+
+    def add_script_tag(group, url)
+      h = { tag: 'script', type: "text/javascript" }
+      h[:src]   = url.start_with?("http") ? url : "/#{Pubba.script_folder}/#{name}-#{group}.js"
+
+      tag_set = (group == "head") ? @head_tags : @body_tags
+      maybe_add_tag(tag_set, h, :src)
+    end
+
+    def maybe_add_tag(tag_set, hash, key)
+      found = false
+      tag_set.each{|tag| found = true if tag[key] == hash[key]}
+      tag_set << hash unless found
+    end
+  end # Page
+end # Pubba