manifest-rails 0.1.2 → 0.1.3

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 YOURNAME
+Copyright 2012 Jonathan Clem
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,30 @@
+# Manifest
+
+Manifest is a [Rails::Engine][rails_engine] content management system, packaged as the RubyGem [manifest-rails][manifest_rails_gem].
+
+It was created out of frustration with the fact that many content management systems require hacks or breaking with their own conventions in order to implement true custom data types, and the fact that many content management systems require view-editing to be done from within the application itself, persisting view templates to the database.
+
+In Manifest, custom data types are sets of Rails models, controllers, and views that Manifest has visibility of. This means that Manifest data types can either be generated with the built-in `manifest:data_type` generator, or can be constructed by hand and easily tied into Manifest.
+
+Views in Manifest are views in Rails. Editing these views and templates is a matter of editing the public-facing views in `app/views` and any custom Manifest views in `app/views/manifest`.
+
+## Getting Started
+
+Getting started with Manifest is as easy as:
+
+1. Add it to your `Gemfile`.
+2. Require it in your `config/application.rb`.
+3. Run the install generator and migrate the database.
+
+Detailed instructions can be found in the [Wiki][wiki] on the [Getting Started][getting_started] page.
+
+## License
+
+Manifest was created by [Jonathan Clem][jclem] and is licensed under the [MIT license][license].
+
+[rails_engine]: http://api.rubyonrails.org/classes/Rails/Engine.html
+[manifest_rails_gem]: http://rubygems.org/gems/manifest-rails
+[wiki]: https://github.com/jclem/manifest-rails/wiki
+[getting_started]: https://github.com/jclem/manifest-rails/wiki/Getting-Started
+[jclem]: http://jclem.net
+[license]: https://github.com/jclem/manifest-rails/blob/master/MIT-LICENSE

data/app/controllers/manifest/content_blocks_controller.rb

@@ -1,3 +1,4 @@
+# Controls CRUD actions for {ContentBlock} objects.
 class Manifest::ContentBlocksController < Manifest::ManifestController
   before_filter :authorize_admin, except: [:index, :edit, :update]
 
@@ -46,6 +47,7 @@ class Manifest::ContentBlocksController < Manifest::ManifestController
 
   private
 
+  # Non-admins may only edit the content of a {ContentBlock}.
   def content_block_params
     if current_editor.admin?
       params[:content_block]

data/app/controllers/manifest/manifest_controller.rb

@@ -1,3 +1,4 @@
+# The primary Manifest admin controller. Mostly used for determining {#current_editor} and for authorization.
 class Manifest::ManifestController < ApplicationController
   before_filter :authorize
 
@@ -5,20 +6,24 @@ class Manifest::ManifestController < ApplicationController
 
   private
 
+  # @return [Editor] the currently signed-in {Editor}, or nil.
   def current_editor
     @current_editor ||= Editor.find(session[:editor_id]) if session[:editor_id]
   end
 
   helper_method :current_editor
 
+  # Redirects to login if {#current_editor} is nil.
   def authorize
     redirect_to manifest_login_url if current_editor.nil?
   end
 
+  # Used to protect sensitive {Page} and {ContentBlock} actions from non-admin {Editor}s.
   def authorize_admin
     redirect_to manifest_path, alert: 'Admins only' unless current_editor.admin?
   end
 
+  # Expires the cached version of every {Page} object view.
   def expire_all_pages
     expire_page '/index.html'
 

data/app/controllers/manifest/pages_controller.rb

@@ -1,3 +1,4 @@
+# Controls CRUD actions for {Page}. Only accessible by admin {Editor}s.
 class Manifest::PagesController < Manifest::ManifestController
   before_filter :authorize_admin, except: [:index, :show]
 

data/app/controllers/manifest/sessions_controller.rb

@@ -1,3 +1,4 @@
+# Creates or destroys {Editor} sessions.
 class Manifest::SessionsController < ApplicationController
   layout 'manifest/sessions'
 

data/app/controllers/pages_controller.rb

@@ -1,8 +1,10 @@
+# The public-facing controller. Responsible for getting {Page} objects, collecting their {ContentBlock}s, and rendering their templates.
 class PagesController < ApplicationController
   layout 'public'
 
   caches_page :show
 
+  # Finds the requested {Page} or raises ActiveRecord::RecordNotFound.
   def show
     if @page = Page.find(params[:id])
       @content_blocks = @page.content_blocks

data/app/form_builders/manifest/labelled_form_builder.rb

@@ -1,3 +1,4 @@
+# Helper for quickly building forms and templates without having to rewrite the same HTML element wrappers.
 class Manifest::LabelledFormBuilder < ActionView::Helpers::FormBuilder
   %w[text_field check_box collection_select check_box text_area date_select datetime_select time_select].each do |method_name|
     define_method(method_name) do |name, *args|

data/app/models/content_block.rb

@@ -1,3 +1,4 @@
+# Belongs to a {Page}. A chunk of presentable content, either made up of plain text or HTML.
 class ContentBlock < ActiveRecord::Base
   extend FriendlyId
   friendly_id :title, use: :slugged
@@ -10,6 +11,7 @@ class ContentBlock < ActiveRecord::Base
 
   default_scope includes(:page).order('pages.title')
 
+  # @return [String] a string of plain text or render-safe HTML.
   def render
     if allow_html
       content.html_safe

data/app/models/editor.rb

@@ -1,3 +1,4 @@
+# Used for authentication.
 class Editor < ActiveRecord::Base
   has_secure_password
 

data/app/models/page.rb

@@ -1,3 +1,4 @@
+# Represents an individual site page, which has many {ContentBlock}s and has an associated template file.
 class Page < ActiveRecord::Base
   extend FriendlyId
   friendly_id :title, use: :slugged
@@ -14,25 +15,32 @@ class Page < ActiveRecord::Base
 
   default_scope order('title')
 
+  # @return [String] the path to the Page's template
   def template_path
     template_path_from_slug(slug)
   end
 
   private
 
+  # Creates the template file after the Page is created.
   def create_template
     %x(touch #{self.template_path})
   end
 
+  # Renames the template file after the Page is updated.
   def rename_template
     old_template_path = template_path_from_slug(slug_was)
     %x(mv #{old_template_path} #{template_path})
   end
 
+  # Removes the template file after the Page is destroyed.
   def remove_template
     %x(rm #{template_path})
   end
 
+  # Generates a Page template path given a slug.
+  # @param [String] slug a Page object's slug attribute.
+  # @return [String] the path to a Page's template based on the given slug.
   def template_path_from_slug(slug)
     "#{Rails.root}/app/views/pages/#{slug}.html.erb"
   end

data/app/views/layouts/manifest/manifest.html.erb

@@ -2,7 +2,7 @@
 
 <html>
 <head>
-  <title>Manifest</title>
+  <title><%= Manifest.configuration.app_name %></title>
 
   <%= stylesheet_link_tag 'manifest/main' %>
   <%= javascript_include_tag 'manifest/main' %>
@@ -13,7 +13,7 @@
 </head>
 <body>
   <div class='app-nav'>
-    <h1>Manifest</h1>
+    <h1><%= Manifest.configuration.app_name %></h1>
 
     <nav>
       <ul>

data/app/views/layouts/manifest/sessions.html.erb

@@ -2,7 +2,7 @@
 
 <html>
 <head>
-  <title>Manifest</title>
+  <title><%= Manifest.configuration.app_name %></title>
 
   <%= stylesheet_link_tag 'manifest/sessions' %>
   <%= stylesheet_link_tag 'manifest/main' %>
@@ -14,7 +14,7 @@
 
 <body>
   <div class='app-nav'>
-    <h1>Manifest</h1>
+    <h1><%= Manifest.configuration.app_name %></h1>
   </div><!-- app-nav -->
 
   <div class='app-content'>

data/config/initializers/manifest.rb

@@ -1,4 +1,6 @@
 module Manifest
+  # Searches for models containing the {ActiveRecord::Base#data_type_for_manifest}
+  # and touches them so that #data_type_for_manifest is called at app initialization.
   def self.add_app_models_to_manifest_data_types
     models = Dir.glob("#{Rails.root}/app/models/*")
 

data/lib/active_record/base/data_type_for_manifest.rb

@@ -1,4 +1,5 @@
 class ActiveRecord::Base
+  # Adds this instance of {ActiveRecord::Base} to Manifest.configuration.data_types.
   def self.data_type_for_manifest
     nav_name = ActiveSupport::Inflector.pluralize(self.to_s)
     route = "manifest_#{nav_name.underscore}_path"

data/lib/generators/manifest/data_type/data_type_generator.rb

@@ -1,5 +1,8 @@
 require 'rails/generators/active_record'
 
+# Creates templates and migrations for custom Manifest data types.
+# Example:
+#   rails generate manifest:data_type Person first_name:string last_name:string
 class Manifest::DataTypeGenerator < ActiveRecord::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
   argument :attributes, type: :array, default: [], banner: 'field:type field:type'

data/lib/generators/manifest/install/install_generator.rb

@@ -1,5 +1,9 @@
 require 'rails/generators/active_record'
 
+# Creates templates and migrations for the initial Manifest install.
+# Example:
+#   rails generate manifest:install Page
+# The "Page" argument is completely arbitrary.
 class Manifest::InstallGenerator < ActiveRecord::Generators::Base
   source_root File.expand_path('../templates', __FILE__)
 

data/lib/manifest.rb

@@ -5,6 +5,7 @@ require 'sass-rails'
 require 'compass-rails'
 require 'tinymce-rails'
 
+# The primary Manifest namespace. Note that {Page}, {Editor}, and {ContentBlock} are not namespaced models.
 module Manifest
   def self.configure
     yield configuration
@@ -14,11 +15,17 @@ module Manifest
     @configuration ||= Configuration.new
   end
 
+  # App configuration, which can be altered in config/initializers/manifest.rb
+  # Example:
+  #   Manifest.configure do |config|
+  #     config.app_name = "My App"
+  #   end
   class Configuration
-    attr_accessor :data_types
+    attr_accessor :data_types, :app_name
 
     def initialize
       @data_types = []
+      @app_name = 'Manifest'
     end
   end
 end

data/lib/manifest/version.rb

@@ -1,3 +1,3 @@
 module Manifest
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: manifest-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-06 00:00:00.000000000 Z
+date: 2012-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2152352920 !ruby/object:Gem::Requirement
+  requirement: &70330392459720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *2152352920
+  version_requirements: *70330392459720
 - !ruby/object:Gem::Dependency
   name: friendly_id
-  requirement: &2152384460 !ruby/object:Gem::Requirement
+  requirement: &70330392458920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152384460
+  version_requirements: *70330392458920
 - !ruby/object:Gem::Dependency
   name: sass-rails
-  requirement: &2152401000 !ruby/object:Gem::Requirement
+  requirement: &70330392458240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 3.2.3
   type: :runtime
   prerelease: false
-  version_requirements: *2152401000
+  version_requirements: *70330392458240
 - !ruby/object:Gem::Dependency
   name: compass-rails
-  requirement: &2152398200 !ruby/object:Gem::Requirement
+  requirement: &70330392457720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152398200
+  version_requirements: *70330392457720
 - !ruby/object:Gem::Dependency
   name: bcrypt-ruby
-  requirement: &2152414400 !ruby/object:Gem::Requirement
+  requirement: &70330392457100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *2152414400
+  version_requirements: *70330392457100
 - !ruby/object:Gem::Dependency
   name: tinymce-rails
-  requirement: &2152412900 !ruby/object:Gem::Requirement
+  requirement: &70330392456560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152412900
+  version_requirements: *70330392456560
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &2152411500 !ruby/object:Gem::Requirement
+  requirement: &70330392456040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152411500
+  version_requirements: *70330392456040
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &2152409980 !ruby/object:Gem::Requirement
+  requirement: &70330392455540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152409980
+  version_requirements: *70330392455540
 - !ruby/object:Gem::Dependency
   name: factory_girl_rails
-  requirement: &2152431140 !ruby/object:Gem::Requirement
+  requirement: &70330392455060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152431140
+  version_requirements: *70330392455060
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &70330392454580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70330392454580
 description: Manifest allows for the creation of simple content management with support
   for easy custom data types. It attempts to preserve the Rails way of working where
   possible.
@@ -175,7 +186,7 @@ files:
 - lib/tasks/manifest_tasks.rake
 - MIT-LICENSE
 - Rakefile
-- README.rdoc
+- README.md
 homepage: http://github.com/jclem/manifest-rails
 licenses: []
 post_install_message: 
@@ -190,7 +201,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3521732521771266211
+      hash: 1014662028778785223
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -199,11 +210,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3521732521771266211
+      hash: 1014662028778785223
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Manifest is a Rails Engine content management system
 test_files: []
+has_rdoc: 

data/README.rdoc

@@ -1,3 +0,0 @@
-= Manifest
-
-This project rocks and uses MIT-LICENSE.