fierce 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c03f28d4d92a16a4dbf0ebbae31c8e32e03a65b
+  data.tar.gz: 72627f2c9a1e2913fe38c687810f29fb5a47be76
+SHA512:
+  metadata.gz: a8c9ef3d7c6fa31b02f38f2615381c010de03552c59dff6055e9527eeb05cbe16d6d59898735e15f7b09a70a5971a91e9dcbf885c1035f7f31444c488eda8ba7
+  data.tar.gz: 3ee6232ef77cba1625943a50b26520aa8a4548a2dc8cd9b12d38d8412fbbb82e191921ff0ef44ed1a2e34c5ae85d09d2c223ed206d7df76399a96f2122faf239

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rvmrc

@@ -0,0 +1,6 @@
+rvm_install_on_use_flag=1
+rvm_trust_rvmrcs_flag=1
+rvm_gemset_create_on_use_flag=1
+
+rvm use 2.0.0@fierce --create
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fierce.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 SocialChorus, Inc.
+
+MIT License
+
+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,144 @@
+# Fierce
+
+Fierce is opinionate view logic for Rails. Templates are written in HTML and tucked into the views directory. View logic is handled by presenters, that have their own top level app directory. These presenters are plain old Ruby objects, not some special subclass of Fierceness. 
+
+![Fierce Conchita Wurst](http://eurovisionireland.files.wordpress.com/2013/10/conchita-wurst-internal-selection.jpg)
+###### Fierce image brought to you by Conchita Wurst: http://eurovisionireland.files.wordpress.com/2013/10/conchita-wurst-internal-selection.jpg.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fierce'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fierce
+
+## Usage
+
+Install the gem and you will be ready to start writing mustache templates. These templates get tucked into the appropriate place in your views directory, just like an ERB or HAML view. As with other view pre-processors, the file name usually includes the ultimate format, for example: show.html.mustache. 
+
+When Rails goes to find the view logic to marry with the mustache, it will look the presenters directory. So, go make a presenters directory! 
+
+  `mkdir app/presenters`
+
+If there a presenter is not found, the mustache gets rendered from the logic it can find. 
+
+Given a mustache template like this:
+
+    <h1>Be Fierce</h1>
+    <p>{{from_instance_variables}}</p>
+    <p>{{from_helpers}}</p>
+    <p>{{from_your_presenter}}</p>
+
+And a controller that exposes an instance variable like so:
+
+    # some controller 
+    def show
+      @from_instance_variable = 'Expose your instance variables sparingly. Sandi Metz will love you for just using one.'
+    end
+
+And a helper somewhere that has this logic:
+
+    def from_helpers
+      "Don't use a helper; it's just bad form ... but if you must, you must."
+    end
+
+And a presenter with a little something too:
+
+    class Presenters::Home::Index
+      def from_your_presenters
+        "Use your presenters. It is a pure Ruby class of your own. Mixins and inheritance just work. One presenter per view. Go!"
+      end
+    end
+
+Will all go together to render some excellent HTML:
+
+    <h1>Be Fierce</h1>
+    <p>Expose your instance variables sparingly. Sandi Metz will love you for just using one.</p>
+    <p>Don't use a helper; it's just bad form ... but if you must, you must.</p>
+    <p>Use your presenters. It is a pure Ruby class of your own. Mixins and inheritance just work. One presenter per view. Go!</p>
+
+#### Presenter Classes
+
+Presenter classes should be put in the same directory structure as the view they are logic-ing:
+
+    app/
+      views/
+        home/
+          index.html.mustache
+
+      presenters/
+        home/
+          index.rb
+
+If you don't follow this pattern, no custom presenter will be used. Instead the mustache will be rendered with whatever it can find in controller instance variable and helpers.
+
+Classes that initialize with a single argument will be passed a default presenter. It will have accessors to those instance variable exposed in the controller. It will also have access to locals and helper methods where appropriate.
+
+Given the setup previously described, helpers, controllers and all:
+
+    class Presenters::Home::Index
+      attr_reader :default_presenter
+
+      def initialize(default_presenter)
+        @default_presenter = default_presenter
+      end
+
+      def contatenated_stuff
+        default_presenter.from_instance_variables + ' '
+          default_presenter.from_helpers + ' '
+          " some other stuff"
+      end
+    end 
+
+#### What about Layouts?
+
+Layouts can be mustache too, with a presenter of their own. This is how to yield the layout content, in a very ERB-styled way:
+
+    <!DOCTYPE html>
+    <html>
+      <head>
+        <title>Fierce Layout</title>
+      </head>
+      <body>
+        {{{yield}}}
+      </body>
+    </html>
+
+Notice the triple curlies: `{{{yield}}}`. They allow the html to be dumped directly into the layout without being escaped in such a way that all the tags show up as text. That's the only trick.
+
+What about using yield with an argument, you ask? Well that seems like a terrible practice, but is should work ok too: `{{{yield.head}}}`.
+
+#### Partials
+
+Mustache views are logicless and cleans. What that means for partials is that a name, not a path needs to be passed in the template:
+
+    {{> my_partial}}
+
+For partials in the same directory as the view being rendered, this nameing works great.
+
+The most powerful partials are shared amongst different templates and are not located in the current view directory. In your custom presenter, you can create a #partials method that returns a hash, mapping names to paths.
+
+    def partials
+      {
+        my_partial: '/reports/show',
+        something_tiny: 'here'
+      }
+    end 
+
+Fierce will find the partials given a map to the paths. What is more, presenters are pure ruby objects and can share this logic amongst views.
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require "bundler/gem_tasks"
+
+desc "uses rails dummy app to integration test gem"
+task :integration_test do
+  Dir.chdir(File.dirname(__FILE__) + "/integration_spec/dummy") do
+    system('rspec')
+  end
+end
+
+desc "runs local specs"
+task :spec do
+  system('rspec')
+end
+
+task :default => [:spec, :integration_test]

data/fierce.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fierce/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fierce"
+  spec.version       = Fierce::VERSION
+  spec.authors       = ["Kane Baccigalupi"]
+  spec.email         = ["developers@socialchorus.com"]
+  spec.description   = %q{Fierce, opinionate view logic for Rails}
+  spec.summary       = %q{Fierce, opinionate view logic for Rails}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mustache"
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rails'
+end

data/integration_spec/dummy/.gitignore

@@ -0,0 +1,16 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*.log
+/tmp

data/integration_spec/dummy/.rspec

@@ -0,0 +1 @@
+--color

data/integration_spec/dummy/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.0.1'
+
+gem 'fierce', path: '../../'
+gem 'haml'
+gem 'rspec-rails'

data/integration_spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/integration_spec/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__)
+
+Dummy::Application.load_tasks

data/integration_spec/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/integration_spec/dummy/app/assets/javascripts/home.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

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

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/integration_spec/dummy/app/assets/stylesheets/home.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/integration_spec/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/integration_spec/dummy/app/controllers/home_controller.rb

@@ -0,0 +1,9 @@
+class HomeController < ApplicationController
+  def index
+    @from_the_ivars = 'Hello from the controller ivars'
+  end
+
+  def show
+    @loop_it = params[:id].to_i
+  end
+end

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

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

data/integration_spec/dummy/app/helpers/home_helper.rb

@@ -0,0 +1,5 @@
+module HomeHelper
+  def from_the_helper
+    'Hello from the helpers'
+  end
+end

data/integration_spec/dummy/app/presenters/home/index.rb

@@ -0,0 +1,15 @@
+module Presenters
+  module Home
+    class Index
+      def from_the_presenter
+        'Hello from the presenter'
+      end
+
+      def partials
+        {
+          far_away: '/layouts/far_away'
+        }
+      end
+    end
+  end
+end

data/integration_spec/dummy/app/presenters/home/show.rb

@@ -0,0 +1,22 @@
+module Presenters
+  module Home
+    class Show
+      attr_reader :view_model
+
+      def initialize(view_model)
+        @view_model = view_model
+      end
+
+      def loop_count
+        view_model.loop_it
+      end
+
+      def loops
+        (1..loop_count).to_a.map{|n| Looplet.new(n) }
+      end
+
+      class Looplet < Struct.new(:n)
+      end
+    end
+  end
+end

data/integration_spec/dummy/app/presenters/layouts/application.rb

@@ -0,0 +1,19 @@
+module Presenters
+  module Layouts
+    class Application
+      attr_reader :view_model
+
+      def initialize(view_model)
+        @view_model = view_model
+      end
+
+      def stylesheets
+        view_model.stylesheet_link_tag('application', media: 'all')
+      end
+
+      def javascripts
+        view_model.javascript_include_tag('application')
+      end
+    end
+  end
+end

data/integration_spec/dummy/app/views/home/_hamlton.html.haml

@@ -0,0 +1 @@
+%p Hello from haml-dom

data/integration_spec/dummy/app/views/home/_local.html.mustache

@@ -0,0 +1 @@
+<p>Hello from a local partial</p>

data/integration_spec/dummy/app/views/home/_looplet.html.mustache

@@ -0,0 +1 @@
+<p>loop {{n}}</p>

data/integration_spec/dummy/app/views/home/index.html.mustache

@@ -0,0 +1,8 @@
+<h1>Hello World</h1>
+
+<p>{{from_the_helper}}</p>
+<p>{{from_the_ivars}}</p>
+<p>{{from_the_presenter}}</p>
+{{> local}}
+{{> far_away}}
+{{> hamlton}}

data/integration_spec/dummy/app/views/home/show.html.mustache

@@ -0,0 +1,4 @@
+<h1>I will loop</h1>
+{{#loops}}
+  {{> looplet}}
+{{/loops}}

data/integration_spec/dummy/app/views/layouts/_far_away.html.mustache

@@ -0,0 +1 @@
+<p>Hello from a partial far, far away</p>

data/integration_spec/dummy/app/views/layouts/application.html.mustache

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Fierce Dummy</title>
+    {{! anywhere we are generating html and inserting, we need to use triple curlies}}
+    
+    {{{csrf_meta_tags}}}
+    {{{stylesheets}}}
+    {{{javascripts}}}
+  </head>
+  <body>
+    {{{yield}}}
+  </body>
+</html>

data/integration_spec/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/integration_spec/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/integration_spec/dummy/bin/rake

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

data/integration_spec/dummy/config/application.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(:default, Rails.env)
+
+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/integration_spec/dummy/config/boot.rb

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

data/integration_spec/dummy/config/environment.rb

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

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

@@ -0,0 +1,27 @@
+Dummy::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
+
+
+  # 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
+end