attributarchy 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 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/README.md

@@ -0,0 +1,80 @@
+[![Version](http://allthebadges.io/epicyclist/attributarchy/badge_fury.png)](http://allthebadges.io/epicyclist/attributarchy/badge_fury)
+[![Dependency Status](https://gemnasium.com/epicyclist/attributarchy.png)](https://gemnasium.com/epicyclist/attributarchy)
+[![Build Status](https://travis-ci.org/epicyclist/attributarchy.png?branch=master)](https://travis-ci.org/epicyclist/attributarchy)
+[![Coverage Status](https://coveralls.io/repos/epicyclist/attributarchy/badge.png)](https://coveralls.io/r/epicyclist/attributarchy)
+[![Code Climate](http://allthebadges.io/epicyclist/attributarchy/code_climate.png)](http://allthebadges.io/epicyclist/attributarchy/code_climate)
+
+
+# Attributarchy
+
+An attribute-driven hierarchy builder for Rails views.
+
+## The Idea
+
+**You do this:**
+
+1. Configure a hierarchy (or hierarchies) of attributes
+1. Create partials for each attribute
+1. Feed this duo some data
+
+**And you get this:**
+
+Dynamic, hierarchical views that allow you to easily dish out an array of layouts, styles, and behavior. All as simple or complex as you'd like.
+
+## Usage
+
+##### In your Gemfile:
+
+```ruby
+  gem 'attributarchy'
+```
+
+##### In your controller:
+
+```ruby
+  include Attributarchy
+
+  has_attributarchy \
+    #----------#
+    # Required #
+    #----------#
+      # Name it, as you can define multiple
+      :name,
+      # Specify an array of attributes that constitute the (?:attribut|hier)archy
+      as: [:attribute, ...],
+    #----------#
+    # Optional #
+    #----------#
+      # Specify an additional lookup path (as a string) or paths (as an array)
+      in: %w[this_path that_path],
+      # Specify an attribute (as a symbol) or attributes (as an array) that will
+      # only be used for grouping -- not rendering
+      without_rendering: [:a_no_show]
+```
+
+##### In your controller's corresponding view directory (or another location configured via :in):
+
+Define a partial for all rendering attributes. The locals provided to these are:
+
+1. *group_data* -- The data set of the grouped-by attribute
+1. *group_value* -- The name of the grouped-by attribute
+1. *group_level* -- An integer representing the position of the grouping within the hierarchy
+
+##### And, finally, in your view:
+
+```ruby
+  build_attributarchy(:name, data_set)
+```
+
+## Working With Engines
+
+My knowledge is limited here, but to get this working in an engine you must specify a full lookup path, e.g.:
+````ruby
+  in: "#{YourEngine::Engine.root}/app/views/your_engine/..."
+````
+
+I believe this is the only way to do this short of converting the gem to a rail tie, but I'm not positive. Besides, I don't want Attributarchy included in *every* controller anyway — it seems quite specialized.
+
+## Examples
+
+To see a simple example, start the dummy rails app and hit its root.

data/Rakefile

@@ -0,0 +1,28 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Attributarchy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+Bundler::GemHelper.install_tasks
+

data/lib/attributarchy.rb

@@ -0,0 +1,10 @@
+require 'attributarchy/controller_methods'
+require 'attributarchy/helpers'
+
+module Attributarchy
+  extend ActiveSupport::Concern
+  included do
+    include Attributarchy::ControllerMethods
+    include Attributarchy::Helpers
+  end
+end

data/lib/attributarchy/controller_methods.rb

@@ -0,0 +1,58 @@
+module Attributarchy
+  module ControllerMethods
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :attributarchy_configuration
+      helper_method :build_attributarchy
+      helper_method :attributarchy_configuration
+    end
+
+    def attributarchy_configuration
+      self.attributarchy_configuration
+    end
+
+    module ClassMethods
+      def has_attributarchy(name, arguments = {})
+        ### Check attribute configuration.
+        raise ArgumentErorr, 'No attributarchy specified' \
+          unless arguments.is_a?(Hash) && arguments.has_key?(:as)
+        attributes = arguments[:as]
+        raise ArgumentError, 'Expecting attributarchy (an array of symbols representing attributes)' \
+          unless attributes.is_a? Array
+        raise ArgumentError, 'Attributarchy cannot be empty' \
+          if attributes.empty?
+        raise ArgumentError, 'Attributarchy should be specified using symbols' \
+          unless attributes.all? { |a| a.is_a? Symbol }
+        ### Lookup prefixes (optional). Always include controller.
+        lookup_prefixes = [controller_name]
+        if arguments.has_key?(:in)
+          additional_lookup_prefixes = arguments[:in]
+          raise ArgumentError, 'Lookup prefixes must be specified as a string or array' \
+            unless [Array, String].any? { |type| additional_lookup_prefixes.is_a?(type) }
+          lookup_prefixes << additional_lookup_prefixes
+        end
+        lookup_prefixes.flatten!
+        lookup_prefixes.map! { |prefix|
+          prefix = "app/views/#{prefix}" unless prefix[0] == '/'
+          prefix
+        }
+        prepend_view_path(lookup_prefixes)
+        ### Group-only attributes that do not render (optional).
+        without_rendering = {}
+        if arguments.has_key?(:without_rendering)
+          without_rendering = arguments[:without_rendering]
+          raise ArgumentError, ':without_rendering must be specified as a symbol or array' \
+            unless [Array, Symbol].any? { |type| without_rendering.is_a?(type) }
+          without_rendering = Hash[*[without_rendering].flatten.map { |k| [k, nil] }.flatten]
+        end
+        ### Set configuration
+        self.attributarchy_configuration ||= {}
+        self.attributarchy_configuration[name] = attributes
+        self.attributarchy_configuration[:without_rendering] = without_rendering
+      end
+    end
+
+  end
+
+end

data/lib/attributarchy/helpers.rb

@@ -0,0 +1,28 @@
+module Attributarchy
+  module Helpers
+    def build_attributarchy(name, data, level_index = 0)
+      output ||= ''
+      output = %{<div class="attributarchy">} if level_index == 0 # Outermost wrapper
+      current_level = attributarchy_configuration[name][level_index]
+      data.group_by(&current_level).each_with_index do |(group_value, group_data), index|
+        output << %{<div class="#{current_level}-attributarchy">}
+        unless attributarchy_configuration[:without_rendering].has_key?(current_level)
+          output << (
+            # TODO: / desired?
+            render_to_string partial: "/#{current_level}", locals: {
+              group_data: group_data,
+              group_value: group_value,
+              group_level: level_index
+            }
+          )
+        end
+        if level_index < attributarchy_configuration[name].count - 1
+          output << build_attributarchy(name, group_data, level_index + 1)
+        end
+        output << '</div>'
+      end
+      output << '</div>' if level_index == 0 # End outermost wrapper
+      output.html_safe
+    end
+  end
+end

data/lib/attributarchy/version.rb

@@ -0,0 +1,3 @@
+module Attributarchy
+  VERSION = "0.0.1"
+end

data/lib/tasks/attributarchy_tasks.rake

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

data/spec/controller_methods_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+module Attributarchy
+  describe ControllerMethods do
+
+    subject { ControllerWithAttributarchy }
+    let(:attributarchy_name) { :a_symbol }
+    let(:valid_attributarchy) {[
+      :a_symbol_representing_an_attribute,
+      :a_symbol_representing_another_attribute,
+      :a_symbol_representing_yet_another_attribute,
+    ]}
+
+    it 'defines the build_attributarchy helper' do
+      expect(subject.new.view_context).to respond_to(:build_attributarchy)
+    end
+
+    it 'defines the attributarchy_configuration helper' do
+      expect(subject.new.view_context).to respond_to(:attributarchy_configuration)
+    end
+
+    describe '#has_attributarchy' do
+
+      context 'when the arguments are invalid' do
+        it 'raises ArgumentError exceptions' do
+          expect { subject.has_attributarchy }.to raise_error ArgumentError
+          expect { subject.has_attributarchy :attributarchy_name, as: [] }.to raise_error ArgumentError
+          expect { subject.has_attributarchy :attributarchy_name, as: ['attribute'] }.to raise_error ArgumentError
+          expect { subject.has_attributarchy :attributarchy_name, as: [:attribute, 'attribute'] }.to raise_error ArgumentError
+        end
+      end
+
+      context 'when the arguments are valid' do
+        let(:attributarchy_view_path) { File.join(rails_view_path, subject.controller_name) }
+        let(:view_paths) { subject.view_paths.to_a.map { |path| path.to_s } }
+
+        it 'sets the attributarchy' do
+          subject.has_attributarchy attributarchy_name, as: valid_attributarchy
+          expect(subject.attributarchy_configuration[attributarchy_name]).to eq(valid_attributarchy)
+          expect(subject.new.view_context.attributarchy_configuration[attributarchy_name]).to eq(valid_attributarchy)
+        end
+
+        it "adds the default lookup path (the controller's views) to the view path" do
+          subject.has_attributarchy attributarchy_name, as: valid_attributarchy
+          expect(view_paths).to include(attributarchy_view_path)
+        end
+
+        context 'when a non-rendering attribute is specified as a symbol' do
+          it 'defines the attribute as non-rendering' do
+            subject.has_attributarchy attributarchy_name,
+              as: [:do_not_render], without_rendering: :do_not_render
+            expect(subject.attributarchy_configuration[:without_rendering]).to include(:do_not_render)
+          end
+        end
+
+        context 'when non-rendering attributes are specified as an array' do
+          it 'defines the attributes as non-rendering' do
+            subject.has_attributarchy attributarchy_name,
+              as: [:do_not_render, :do_not_render_either], without_rendering: [:do_not_render, :do_not_render_either]
+            expect(subject.attributarchy_configuration[:without_rendering]).to include(:do_not_render)
+            expect(subject.attributarchy_configuration[:without_rendering]).to include(:do_not_render_either)
+          end
+        end
+
+        context 'when a lookup path is specified' do
+          it 'accepts a string' do
+            subject.has_attributarchy attributarchy_name, as: valid_attributarchy, in: 'path'
+            expect(view_paths).to include(File.join(rails_view_path, 'path'))
+          end
+          it 'accepts an array' do
+            subject.has_attributarchy attributarchy_name, as: valid_attributarchy, in: ['path']
+            expect(view_paths).to include(File.join(rails_view_path, 'path'))
+          end
+        end
+      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
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- 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.