wiselinks-artirix 1.3.0

data/lib/assets/javascripts/wiselinks.js.coffee

@@ -0,0 +1,37 @@
+#= require_tree ./lib
+# require_tree ./lib_old
+
+#= require _page
+#= require _link
+#= require _form
+
+class Wiselinks
+  constructor: ($target = $('body'), @options = {}) ->
+    this._try_jquery()
+
+    @options = $.extend(this._defaults(), @options)
+    if this.enabled()
+      if @options.disable_suid then History.options.disableSuid = true
+      @page = new _Wiselinks.Page($target, @options)
+
+  enabled: ->
+    !History.emulated.pushState || @options.html4 == true
+
+  load: (url, target, render = 'template') ->
+    @page.load(url, target, render)
+
+  reload: () ->
+    @page.reload()
+
+  _defaults: ->
+    disable_suid: true
+    html4: true
+    html4_root_path: '/'
+    html4_normalize_path: true
+    target_missing: null
+    assets_digest: $("meta[name='assets-digest']").attr("content")
+
+  _try_jquery: ->
+    throw new Error("[Wiselinks] jQuery is not loaded") unless window.jQuery?
+
+window.Wiselinks = Wiselinks

data/lib/wiselinks-artirix.rb

@@ -0,0 +1 @@
+require_relative './wiselinks'

data/lib/wiselinks.rb

@@ -0,0 +1,27 @@
+require 'wiselinks/request'
+
+require 'wiselinks/controller_methods'
+require 'wiselinks/rendering'
+
+require 'wiselinks/helpers'
+
+require 'wiselinks/logger'
+
+require 'wiselinks/rails' if defined?(::Rails)
+
+module Wiselinks
+  extend Logger
+
+  DEFAULTS = {
+    :assets_digest => nil,
+    :logger => nil
+  }
+
+  def self.options
+    @options ||= DEFAULTS.dup
+  end
+
+  def self.options=(value)
+    @options = value
+  end
+end

data/lib/wiselinks/controller_methods.rb

@@ -0,0 +1,67 @@
+module Wiselinks
+  module ControllerMethods
+
+    def self.included(base)
+      base.helper_method :wiselinks_title
+      base.helper_method :wiselinks_description
+      base.helper_method :wiselinks_canonical
+      base.helper_method :wiselinks_robots
+      base.helper_method :wiselinks_link_rel_prev
+      base.helper_method :wiselinks_link_rel_next
+      base.before_filter :set_wiselinks_url
+    end
+
+  protected
+
+    def wiselinks_layout
+      'wiselinks'
+    end
+
+    def wiselinks_title(value)
+      if self.request.wiselinks? && value.present?
+        Wiselinks.log("title: #{value}")
+        self.response.headers['X-Wiselinks-Title'] = URI.encode(value)
+      end
+    end
+
+    def wiselinks_description(value)
+      if self.request.wiselinks? && value.present?
+        Wiselinks.log("description: #{value}")
+        self.response.headers['X-Wiselinks-Description'] = URI.encode(value)
+      end
+    end
+
+    def wiselinks_canonical(value)
+      if self.request.wiselinks? && value.present?
+        Wiselinks.log("canonical: #{value}")
+        self.response.headers['X-Wiselinks-Canonical'] = URI.encode(value)
+      end
+    end
+
+    def wiselinks_robots(value)
+      if self.request.wiselinks? && value.present?
+        Wiselinks.log("robots: #{value}")
+        self.response.headers['X-Wiselinks-Robots'] = URI.encode(value)
+      end
+    end
+
+    def wiselinks_link_rel_prev(value)
+      if self.request.wiselinks? && value.present?
+        Wiselinks.log("link_rel_prev: #{value}")
+        self.response.headers['X-Wiselinks-LinkRelPrev'] = URI.encode(value)
+      end
+    end
+
+    def wiselinks_link_rel_next(value)
+      if self.request.wiselinks? && value.present?
+        Wiselinks.log("link_rel_next: #{value}")
+        self.response.headers['X-Wiselinks-LinkRelNext'] = URI.encode(value)
+      end
+    end
+
+    def set_wiselinks_url
+      # self.response.headers['X-Wiselinks-Url'] = request.env['REQUEST_URI'] if self.request.wiselinks?
+      self.response.headers['X-Wiselinks-Url'] = request.url if self.request.wiselinks?
+    end
+  end
+end

data/lib/wiselinks/helpers.rb

@@ -0,0 +1,9 @@
+module Wiselinks
+  module Helpers
+    def wiselinks_meta_tag
+      if Wiselinks.options[:assets_digest].present?
+        tag('meta', :name => 'assets-digest', :content => Wiselinks.options[:assets_digest])
+      end
+    end
+  end
+end

data/lib/wiselinks/logger.rb

@@ -0,0 +1,11 @@
+module Wiselinks
+  module Logger
+    def logger
+      @logger ||= Wiselinks.options[:logger] || ::Logger.new(STDOUT)
+    end
+
+    def log(message)
+      self.logger.info("  [wiselinks] #{message}")
+    end
+  end
+end

data/lib/wiselinks/rails.rb

@@ -0,0 +1,22 @@
+module Wiselinks
+  module Rails
+    class Engine < ::Rails::Engine
+      initializer 'wiselinks.register_logger' do
+        Wiselinks.options[:logger] = ::Rails.logger
+      end
+
+      initializer "wiselinks.register_extensions"  do
+        ActionDispatch::Request.send :include, Request
+        ActionController::Base.send :include, ControllerMethods
+        ActionController::Base.send :include, Rendering
+        ActionView::Base.send :include, Helpers
+      end
+
+      initializer "wiselinks.register_assets_digest"  do
+        if ::Rails.application.config.assets.digest && ::Rails.application.config.assets.digests.present?
+          Wiselinks.options[:assets_digest] ||= Digest::MD5.hexdigest(::Rails.application.config.assets.digests.values.join)
+        end
+      end
+    end
+  end
+end

data/lib/wiselinks/rendering.rb

@@ -0,0 +1,37 @@
+module Wiselinks
+  module Rendering
+
+    def self.included(base)
+      base.alias_method_chain :render, :wiselinks
+    end
+
+  protected
+
+    def render_with_wiselinks(*args, &block)
+      options = _normalize_args(*args)
+
+      if self.request.wiselinks?
+        self.headers['Cache-Control'] = 'no-cache, no-store, max-age=0, must-revalidate'
+        self.headers['Pragma'] = 'no-cache'
+
+        if self.request.wiselinks_partial?
+          Wiselinks.log("Processing partial request")
+          options[:partial] ||= action_name
+        else
+          Wiselinks.log("Processing template request")
+          if Wiselinks.options[:layout] != false
+            options[:layout] = self.wiselinks_layout
+          end
+        end
+
+        if Wiselinks.options[:assets_digest].present?
+          Wiselinks.log("Assets digest #{Wiselinks.options[:assets_digest]}")
+
+          self.headers['X-Wiselinks-Assets-Digest'] = Wiselinks.options[:assets_digest]
+        end
+      end
+
+      self.render_without_wiselinks(options, &block)
+    end
+  end
+end

data/lib/wiselinks/request.rb

@@ -0,0 +1,29 @@
+module Wiselinks
+  module Request
+    def self.included(base)
+      base.alias_method_chain :referer, :wiselinks
+      base.alias_method_chain :referrer, :wiselinks
+    end
+
+    def referer_with_wiselinks
+      self.headers['X-Wiselinks-Referer'] || self.referer_without_wiselinks
+    end
+
+    def referrer_with_wiselinks
+      self.referer_with_wiselinks
+    end
+
+    def wiselinks?
+      self.headers['X-Wiselinks'].present?
+    end
+
+    def wiselinks_template?
+      self.wiselinks? && self.headers['X-Wiselinks'] != 'partial'
+    end
+
+    def wiselinks_partial?
+      self.wiselinks? && self.headers['X-Wiselinks'] == 'partial'
+    end
+  end
+end
+

data/lib/wiselinks/version.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Wiselinks
+  module Version
+    MAJOR = 1
+    MINOR = 3
+    PATCH = 0
+    BUILD = nil
+
+    STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+  end
+end

data/spec/cases/helpers_spec.rb

@@ -0,0 +1,8 @@
+require "helper"
+
+feature 'Assets change detection' do
+  scenario 'with an assets digest enabled' do
+    visit('/')
+    page.should have_xpath("//head/meta[@name='assets-digest']", :visible => false)
+  end
+end

data/spec/cases/request_spec.rb

@@ -0,0 +1,113 @@
+require "helper"
+
+describe ActionDispatch::Request do
+  describe 'request' do
+    before :all do
+      @request = FactoryGirl.build(:request)
+    end
+
+    it "should be" do
+      @request.should be
+    end
+
+    context 'should respond to wiselinks methods' do
+      it '#wiselinks?' do
+        @request.should respond_to(:wiselinks?)
+      end
+
+      it '#wiselinks_template?' do
+        @request.should respond_to(:wiselinks_template?)
+      end
+
+      it '#wiselinks_partial?' do
+        @request.should respond_to(:wiselinks_partial?)
+      end
+    end
+
+    context 'wiselinks methods' do
+      it 'should not be a wiselinks request' do
+        @request.wiselinks?.should == false
+      end
+
+      it 'should not be a wiselinks template request' do
+        @request.wiselinks_template?.should == false
+      end
+
+      it 'should not be a wiselinks partial request' do
+        @request.wiselinks_partial?.should == false
+      end
+    end
+  end
+
+  describe 'wiselinks_request' do
+    before :all do
+      @request = FactoryGirl.build(:wiselinks_request)
+    end
+
+    it "should be" do
+      @request.should be
+    end
+
+    context 'wiselinks methods' do
+      it 'should be a wiselinks request' do
+        @request.wiselinks?.should == true
+      end
+
+      it 'should be a wiselinks template request' do
+        @request.wiselinks_template?.should == true
+      end
+
+      it 'should not be a wiselinks partial request' do
+        @request.wiselinks_partial?.should == false
+      end
+    end
+  end
+
+  describe 'wiselinks_template_request' do
+    before :all do
+      @request = FactoryGirl.build(:wiselinks_template_request)
+    end
+
+    it "should be" do
+      @request.should be
+    end
+
+    context 'wiselinks methods' do
+      it 'should be a wiselinks request' do
+        @request.wiselinks?.should == true
+      end
+
+      it 'should be a wiselinks template request' do
+        @request.wiselinks_template?.should == true
+      end
+
+      it 'should not be a wiselinks partial request' do
+        @request.wiselinks_partial?.should == false
+      end
+    end
+  end
+
+  describe 'wiselinks_partial_request' do
+    before :all do
+      @request = FactoryGirl.build(:wiselinks_partial_request)
+    end
+
+    it "should be" do
+      @request.should be
+    end
+
+    context 'wiselinks methods' do
+      it 'should be a wiselinks request' do
+        @request.wiselinks?.should == true
+      end
+
+      it 'should not be a wiselinks template request' do
+        @request.wiselinks_template?.should == false
+      end
+
+      it 'should be a wiselinks partial request' do
+        @request.wiselinks_partial?.should == true
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.