perspectives 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c92d0eb6138314d35867e5450affaf7ebc7dfb79
+  data.tar.gz: ae22657295f39e2e948cef53acf8182c0ec68250
+SHA512:
+  metadata.gz: 0a52edcc6118fd6840d4df8685f735e2bc0553a6aa6eed2b7626219137370ec3c00b7b18a7d90f344461407f07cf7f160279ec7589787b884c7d037778211c8f
+  data.tar.gz: 6755f9c7e108b17ee9c019c5d453c91d8ad195b7dcd947d904e4750d34253cc2b93a93b8f203deecb462ac522be43437ee8172bd59874366c71fd0ac9817a3a9

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,13 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/generators/perspectives/install.rb

@@ -0,0 +1,38 @@
+require 'rails/generators'
+
+module Perspectives
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      desc "Installs Perspectives and configures the Asset Pipeline"
+
+      def add_assets
+        js_manifest = 'app/assets/javascripts/application.js'
+
+        if File.exist?(js_manifest)
+          requirements = <<-REQS.strip
+//= require mustache-0.8.1
+//= require perspectives
+//= require perspectives_views
+//= require_tree ../../mustaches
+          REQS
+
+          gsub_file js_manifest, %r{^//= require turbolinks$}, ''
+
+          insert_into_file js_manifest, "#{requirements}", :after => "jquery_ujs\n"
+          insert_into_file js_manifest, "\n$(function() { $(document).perspectives('a', 'body') })\n", :after => "//= require_tree .\n"
+        else
+          copy_file "application.js", js_manifest
+        end
+      end
+
+      def configure_directories
+        %w(app/mustaches app/perspectives).each do |dir|
+          empty_directory dir
+          create_file File.join(dir, '.keep')
+        end
+      end
+    end
+  end
+end
+

data/lib/generators/perspectives/scaffold/scaffold_generator.rb

@@ -0,0 +1,54 @@
+require 'rails/generators'
+require 'rails/generators/resource_helpers'
+
+module Perspectives
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_root_folders
+        empty_directory mustache_path
+        empty_directory perspectives_path
+      end
+
+      def copy_view_files
+        available_views.each do |view|
+          template "#{view}.mustache", mustache_path("#{view}.mustache")
+          template "#{view}.rb", perspectives_path("#{view}.rb")
+        end
+      end
+
+      # hook_for :form_builder, :as => :scaffold
+
+      def copy_form_file
+        filename = 'form.mustache'
+        template filename, mustache_path(filename)
+
+        filename = 'form.rb'
+        template filename, perspectives_path(filename)
+      end
+
+      protected
+
+      def available_views
+        %w(index tiny show new edit)
+      end
+
+      def handler
+        :perspectives
+      end
+
+      def mustache_path(filename = nil)
+        File.join(*["app/mustaches", controller_file_path, filename].compact)
+      end
+
+      def perspectives_path(filename = nil)
+        File.join(*["app/perspectives", controller_file_path, filename].compact)
+      end
+    end
+  end
+end

data/lib/generators/perspectives/scaffold/templates/edit.mustache

@@ -0,0 +1,6 @@
+<h1>Editing <%= singular_table_name %></h1>
+
+{{{form}}}
+
+<a href="{{show_href}}">Show</a>
+<a href="{{index_href}}">Back</a>

data/lib/generators/perspectives/scaffold/templates/edit.rb

@@ -0,0 +1,8 @@
+class <%= controller_class_name %>::Edit < Perspectives::Base
+  param :<%= singular_table_name %>
+
+  property(:show_href) { <%= singular_table_name %>_path(<%= singular_table_name %>) }
+  property(:index_href) { <%= plural_table_name %>_path }
+
+  nested 'form', <%= singular_table_name %>: :<%= singular_table_name %>
+end

data/lib/generators/perspectives/scaffold/templates/form.mustache

@@ -0,0 +1,25 @@
+<form accept-charset="UTF-8" action="{{submit_to}}" method="post" data-type="json" data-remote="true">
+  {{#errors}}
+  <div id="error_explanation">
+    <h3>{{error_count}} prohibited this {{name}} from being saved:</h3>
+
+    <ul>
+      {{#error_messages}}
+      <li>{{msg}}</li>
+      {{/error_messages}}
+    </ul>
+  </div>
+  {{/errors}}
+
+  {{#submit_method}}
+    <input type="hidden" name="_method" value="{{submit_method}}">
+  {{/submit_method}}
+
+<% attributes.each do |attribute| -%>
+  {{{<%= attribute.name %>_field}}}
+<% end -%>
+
+  <div class="actions">
+    <input name="commit" type="submit" value="Submit" data-disable-with="Working...">
+  </div>
+</form>

data/lib/generators/perspectives/scaffold/templates/form.rb

@@ -0,0 +1,27 @@
+class <%= controller_class_name %>::Form < Perspectives::Base
+  param :<%= singular_table_name %>
+
+  property(:submit_to) do
+    <%= singular_table_name %>.new_record? ? <%= plural_table_name %>_path : <%= singular_table_name %>_path(<%= singular_table_name %>)
+  end
+
+  property(:submit_method) { !<%= singular_table_name %>.new_record? && 'patch' }
+
+  property(:errors) do
+    errors = <%= singular_table_name %>.errors
+    if errors.any?
+      {
+        error_count: errors.count,
+        name: <%= singular_table_name %>.class.name.humanize,
+        error_messages: object.errors.full_messages.map { |msg| {msg: msg } }
+      }
+    end
+  end
+
+<% attributes.each do |attribute| -%>
+  nested 'perspectives/forms/text_field',
+    property: :<%= attribute.name %>_field,
+    locals: { object: :<%= singular_table_name %>, field: '<%= attribute.name %>' }
+
+<% end -%>
+end

data/lib/generators/perspectives/scaffold/templates/index.mustache

@@ -0,0 +1,22 @@
+<h1>Listing <%= plural_table_name %></h1>
+
+<table>
+  <thead>
+    <tr>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+      <th><%= attribute.human_name %></th>
+<% end -%>
+      <th></th>
+      <th></th>
+      <th></th>
+    </tr>
+  </thead>
+
+  <tbody>
+    {{{<%= plural_table_name %>}}}
+  </tbody>
+</table>
+
+<br>
+
+<a href="{{new_href}}">New <%= singular_table_name %></a>

data/lib/generators/perspectives/scaffold/templates/index.rb

@@ -0,0 +1,9 @@
+class <%= controller_class_name %>::Index < Perspectives::Base
+  param :all_<%= plural_table_name %>
+
+  property(:new_href) { new_<%= singular_table_name %>_path }
+
+  nested_collection '<%= plural_table_name %>/tiny',
+    collection: proc { all_<%= plural_table_name %> },
+    property: :<%= plural_table_name %>
+end

data/lib/generators/perspectives/scaffold/templates/new.mustache

@@ -0,0 +1,5 @@
+<h1>New <%= singular_table_name %></h1>
+
+{{{form}}}
+
+<a href="{{index_href}}">Back</a>

data/lib/generators/perspectives/scaffold/templates/new.rb

@@ -0,0 +1,7 @@
+class <%= controller_class_name %>::New < Perspectives::Base
+  param :<%= singular_table_name %>
+
+  property(:index_href) { <%= plural_table_name %>_path }
+
+  nested 'form', <%= singular_table_name %>: :<%= singular_table_name %>
+end

data/lib/generators/perspectives/scaffold/templates/show.mustache

@@ -0,0 +1,10 @@
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+<p>
+  <strong><%= attribute.human_name %>:</strong>
+  {{<%= attribute.name %>}}
+</p>
+
+<% end -%>
+
+<a href="{{edit_href}}">Edit</a>
+<a href="{{index_href}}">Back</a>

data/lib/generators/perspectives/scaffold/templates/show.rb

@@ -0,0 +1,8 @@
+class <%= controller_class_name %>::Show < Perspectives::Base
+  param :<%= singular_table_name %>
+
+  delegate_property <%= attributes.map { |a| ":#{a.name}" }.join(', ') %>, to: :<%= singular_table_name %>
+
+  property(:edit_href) { edit_<%= singular_table_name %>_path(<%= singular_table_name %>) }
+  property(:index_href) { <%= plural_table_name %>_path }
+end

data/lib/generators/perspectives/scaffold/templates/tiny.mustache

@@ -0,0 +1,8 @@
+<tr>
+<% attributes.reject(&:password_digest?).each do |attribute| -%>
+  <td>{{<%= attribute.name %>}}</td>
+<% end %>
+  <td><a href="{{show_href}}">Show</a></td>
+  <td><a href="{{edit_href}}">Edit</a></td>
+  <td><a href="{{show_href}}" data-method="delete" data-confirm="Are you sure?" rel="nofollow">Destroy</a></td>
+</tr>

data/lib/generators/perspectives/scaffold/templates/tiny.rb

@@ -0,0 +1,8 @@
+class <%= controller_class_name %>::Tiny < Perspectives::Base
+  param :<%= singular_table_name %>
+
+  delegate_property <%= attributes.map { |a| ":#{a.name}" }.join(', ') %>, to: :<%= singular_table_name %>
+
+  property(:show_href) { <%= singular_table_name %>_path(<%= singular_table_name %>) }
+  property(:edit_href) { edit_<%= singular_table_name %>_path(<%= singular_table_name %>) }
+end

data/lib/generators/perspectives/templates/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require mustache-0.8.1
+//= require perspectives
+//= require_tree ../../mustaches
+//= require perspectives_views
+//= require_tree .
+
+$(function() { $(document).perspectives('a', 'body') })

data/lib/generators/perspectives/templates/rails/scaffold_controller/controller.rb

@@ -0,0 +1,82 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_file_path %>/application_controller"
+
+<% end -%>
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  before_action :set_<%= singular_table_name %>, only: [:show, :edit, :update, :destroy]
+
+  perspectives_actions
+
+  # GET <%= route_url %>
+  def index
+    respond_with(perspective('<%= plural_table_name %>/index', all_<%= plural_table_name %>: <%= orm_class.all(class_name) %>))
+  end
+
+  # GET <%= route_url %>/1
+  def show
+    respond_with(perspective('<%= plural_table_name %>/show', <%= singular_table_name %>: @<%= singular_table_name %>))
+  end
+
+  # GET <%= route_url %>/new
+  def new
+    respond_with(perspective('<%= plural_table_name %>/new', <%= singular_table_name %>: <%= orm_class.build(class_name) %>))
+  end
+
+  # GET <%= route_url %>/1/edit
+  def edit
+    respond_with(perspective('<%= plural_table_name %>/edit', <%= singular_table_name %>: @<%= singular_table_name %>))
+  end
+
+  # POST <%= route_url %>
+  def create
+    <%= singular_table_name %> = <%= orm_class.build(class_name, "#{singular_table_name}_params") %>
+
+    if <%= orm_instance.save %>
+      flash[:notice] = <%= "'#{human_name} was successfully created.'" %>
+
+      respond_to do |format|
+        format.html { redirect_to <%= singular_table_name %> }
+        format.json { render json: perspective('<%= plural_table_name %>/show', <%= singular_table_name %>: <%= singular_table_name %>), status: :created, location: <%= singular_table_name %> }
+      end
+    else
+      respond_with(perspective('<%= plural_table_name %>/new', <%= singular_table_name %>: <%= singular_table_name %>))
+    end
+  end
+
+  # PATCH/PUT <%= route_url %>/1
+  def update
+    if @<%= orm_instance.update("#{singular_table_name}_params") %>
+      flash[:notice] = <%= "'#{human_name} was successfully updated.'" %>
+
+      respond_to do |format|
+        format.html { redirect_to @<%= singular_table_name %> }
+        format.json { render json: perspective('<%= plural_table_name %>/show', <%= singular_table_name %>: @<%= singular_table_name %>) }
+      end
+    else
+      respond_with(perspective('<%= plural_table_name %>/edit', <%= singular_table_name %>: @<%= singular_table_name %>))
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  def destroy
+    @<%= orm_instance.destroy %>
+    redirect_to <%= index_helper %>_url, notice: <%= "'#{human_name} was successfully destroyed.'" %>
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_<%= singular_table_name %>
+      @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def <%= "#{singular_table_name}_params" %>
+      <%- if attributes_names.empty? -%>
+      params[<%= ":#{singular_table_name}" %>]
+      <%- else -%>
+      params.require(<%= ":#{singular_table_name}" %>).permit(<%= attributes_names.map { |name| ":#{name}" }.join(', ') %>)
+      <%- end -%>
+    end
+end
+<% end -%>

data/lib/perspectives/active_record.rb

@@ -0,0 +1,17 @@
+module Perspectives
+  module ActiveRecord
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def id_param
+        :"#{active_record_klass.name.underscore}_id"
+      end
+
+      def active_record_klass
+        name.split('::').first.singularize.constantize
+      end
+    end
+  end
+end

data/lib/perspectives/base.rb

@@ -0,0 +1,30 @@
+require 'forwardable'
+require 'perspectives/templating'
+require 'perspectives/properties'
+require 'perspectives/memoization'
+require 'perspectives/params'
+require 'perspectives/context'
+require 'perspectives/rendering'
+require 'perspectives/caching'
+
+module Perspectives
+  class Base
+    include Templating
+    include Properties
+    include Memoization
+    include Params
+    include Context
+    include Rendering
+    include Caching
+
+    class << self
+      def inherited(base)
+        base.__send__(:filename=, caller.first[/^(.*?.rb):\d/, 1])
+      end
+
+      private
+
+      attr_accessor :filename
+    end
+  end
+end

data/lib/perspectives/caching.rb

@@ -0,0 +1,82 @@
+module Perspectives
+  module Caching
+    def self.included(base)
+      base.extend(ClassMethods)
+
+      base.class_eval do
+        class_attribute :_cache_key_additions_block
+        delegate :_class_source_digest, :_mustache_source_digest, to: 'self.class'
+      end
+    end
+
+    def render_html
+      _with_cache('html') { super }
+    end
+
+    def to_json(options = {})
+      _with_cache('json') { super }
+    end
+
+    private
+
+    def _cache
+      Perspectives.cache
+    end
+
+    def _expand_cache_key(*args, &block)
+      Perspectives.expand_cache_key(*args, &block)
+    end
+
+    def _with_cache(*key_additions)
+      return yield unless _caching?
+
+      _cache.fetch(_expand_cache_key(_cache_key.concat(key_additions))) { yield }
+    end
+
+    def _cache_key
+      return [] unless _caching?
+
+      [].tap do |key|
+        key << self.class.to_s
+        key << _mustache_source_digest
+        key << _class_source_digest
+        key.concat(Array(instance_eval(&_cache_key_additions_block))) if _cache_key_additions_block
+        key.concat _dependent_cache_keys
+      end
+    end
+
+    def _caching?
+      Perspectives.caching? && !!_cache_key_additions_block
+    end
+
+    def _dependent_cache_keys
+      _nested_perspectives.each_with_object([]) do |property_name, key|
+        perspectives = __send__(property_name)
+
+        case perspectives
+        when NilClass
+        when Array
+          key.concat(perspectives.map { |p| p.__send__(:_cache_key) }.flatten)
+        else
+          key.concat(perspectives.__send__(:_cache_key))
+        end
+      end
+    end
+
+    module ClassMethods
+      def cache(&block)
+        raise ArgumentError, "No block given" unless block_given?
+
+        self._cache_key_additions_block = block
+      end
+
+      def _class_source_digest
+        @_class_source_digest ||= Digest::MD5.hexdigest(File.read(filename))
+      end
+
+      def _mustache_source_digest
+        @_mustache_source_digest ||= Digest::MD5.hexdigest(_mustache.template.source)
+      end
+    end
+  end
+end

data/lib/perspectives/collection.rb

@@ -0,0 +1,21 @@
+module Perspectives
+  class Collection
+    include ::Enumerable
+
+    def initialize(perspectives)
+      @perspectives = perspectives
+    end
+
+    def each(&block)
+      perspectives.each(&block)
+    end
+
+    def to_html
+      perspectives.map(&:to_html).join
+    end
+    alias_method :to_s, :to_html
+
+    private
+    attr_reader :perspectives
+  end
+end

data/lib/perspectives/configuration.rb

@@ -0,0 +1,14 @@
+module Perspectives
+  class Configuration
+    delegate :template_path, :template_path=, :raise_on_context_miss?, :raise_on_context_miss, :raise_on_context_miss=, to: 'Mustache'
+
+    CacheNotConfigured = Class.new(StandardError)
+    attr_writer :cache
+    attr_accessor :caching
+    alias_method :caching?, :caching
+
+    def cache
+      @cache || (raise CacheNotConfigured, "You must configure a cache")
+    end
+  end
+end

data/lib/perspectives/context.rb

@@ -0,0 +1,18 @@
+module Perspectives
+  module Context
+    def respond_to?(method, include_private = false)
+      super || context.key?(method)
+    end
+
+    private
+
+    def method_missing(method, *args, &block)
+      if args.empty? && !block_given? && context.key?(method)
+        self.class.__send__(:define_method, method) { __send__(:context).fetch(method) }
+        __send__(method)
+      else
+        super
+      end
+    end
+  end
+end