inkling 0.0.3a

data/README.txt

@@ -0,0 +1,194 @@
+Inkling is a DSL and framework for Rails 3 providing for defining your own knowledge management system. 
+
+Feature Overview
+----------------
+
+Types:
+
+ActiveRecord objects can be adopted by the framework. Define your ActiveRecord with 'act_as_inkling' and it will be included in the system with menuing, security, routing, workflows.
+
+Namespacing:
+
+All tables are namespaced - e.g. inkling_users - to avoid collision with other tables - e.g. the user table of an ecommerce app..
+
+Dashboard:
+
+Create a partial (_.+*_dashboard.+*) in your app and it will be automatically included in the dashboard. So you can extend the interface for your own users and integrate whatever you like.
+
+Tree:
+
+A tree UI presents the arrangement of all types in the system, letting users drag and drop inklings, create news ones, edit them, etc..
+
+Permissioning:
+
+There's one default role, the administrator, that can do everything. But you can create others, and give them permissions (to, say, create but not delete images). You can also create new permissions and new roles for your own extensions. (Inkling uses CanCan)
+
+Devise Authentication:
+
+The authentication system can be turned on or off (you would turn it off to integrate it within your own app's authentication). It uses Devise (see http://github.com/plataformatec/devise)
+
+Workflow API: (coming)
+
+A simple default Workflow - draft -> publish - is included for most objects, but you can define your own and attach them to any inkling type.
+
+
+
+
+For more see the Development Guide (http://wiki.github.com/biv/inkling/developers-guide) and the Roadmap (http://wiki.github.com/biv/inkling/roadmap).
+
+
+The documentation below is a work in progress and will be revised at some point. The Installing advice is current.
+
+Installing
+----------
+
+Some quick instructions for setting up Inkling and Inkling-CMS to get an idea of what's being built.
+
+Clone inkling.
+
+Go into inkling, run 'bundle install' (you'll need Ruby 1.9.x).
+
+cd testapp
+
+Configure your config/database.yml with a database for the test app. 
+
+rake install
+
+rake inkling:bootstrap
+
+
+Implementing your own System
+----------------------------
+
+1) Define themes.
+
+The administrator account will always be able to see the Inkling administrator layout, which contains configuration information. To implement a system, you must define two themes:
+
+The management theme - this is the layout backend users will see when they use your system.
+The content theme - this is the theme public visitors will see when they look at content.
+
+
+
+Running The Tests
+-----------------
+Inkling is an engine and needs a Rails application to execute its tests against. Tests (rspec examples and cucumber features) are kept in the top level engine directory, and symlinked into the testapp/spec and testapp/featured directories.
+
+To run the tests:
+
+cd testapp
+
+rake inkling:megatest #(a custom task which runs the environment, rspec, then features)
+
+
+EXTENDING INKLING
+-----------------
+
+
+Content Type
+------------
+�For an example of a content type, see inkling-cms or Inkling::Foo (in this project).
+
+A generator for content types will be built at some stage, in the meantime, CTs follow some norms in Rails.
+
+To create a Content Type:
+
+* the model should act_as_content
+
+class Acme::Mp3 < ActiveRecord::Base
+  acts_as_content 'mp3'
+end
+
+The string arg. is optional, but provides a friendly name to use in the admin UI - a content creator will have the option to create an
+'mp3'and not an 'Acme::Mp3'.
+
+* the model should have a name field, preferably a String. This is used to make it addressable in a URL by site categorization.
+
+Two controllers are presumed to exist, one to let permitted users manage the object (CRUD):
+
+class Inkling::ContentTypes::Mp3sController < Inkling::BaseController
+end
+
+And another with a show method capable of rendering it:
+
+class Inkling::Mp3sController < Inkling::BaseController; end
+
+These namespaces are presumed to exist, although options may appear later for other namespaces.
+
+The admin controller presumes CRUD methods (and routes) available for the model. The other controller is simply in charge
+of rendering, and relies upon the 'show' method being implemented. When Inkling receives a request for an mp3 which is situated
+in a folder somewhere in its site, it will call to the show method with an id.
+
+Your content type is automatically included in the Content Tree. If you wish to restrict what types of content can be placed directly beneath it,
+implement the restricts method on your content object.
+
+For example,
+
+class Acme::Mp3 < ActiveRecord::Base
+  acts_as_inkling 'mp3'
+  
+  def restricts(content)
+    unless content.is_a? Acme::MusicVideo
+      [true, "MP3s can only include Music Videos."]
+    end
+  end
+end
+
+
+Roles
+-----
+
+Inkling only specifies one role - administrator. The hosting app. is able to create more.
+
+Roles & Authentication & Landing Page
+-------------------------------------
+
+Inkling uses Devise, which searches for a user_root_path and then defaults a root_path, in that order. Inkling defines a inkling_user_root route (run 'rake routes') to reach the Inkling dashboard. If you want authenticating users to land here, map user_root or root to this:
+
+match 'home', :to => 'admin/inkling/home#dashboard', :as => "user_root"
+
+
+
+Integrated Dashboard
+--------------------
+
+Each user lands on the dashboard - app/views/inkling/users/home#dashboard. Inkling scans all engines for this directory, looking for files with _dashboard. and rendering them as partials. Thus, if you want your engine to add its own section to the dashboard, create a partial.
+
+For example, if you have written a blog content type, and want to offer blog links create app/views/inkling/users/home/_blog_dashboard.html.erb (or haml, etc.). This will be rendered within the dashboard.
+
+Contributors
+------------
+
+Thanks to
+* Clifford Heath (contributing installation docs + the command line binary that will be used to generate Content Type engines). May, 2010.
+
+Copyright Notice
+----------------
+COPYRIGHT (c) 2010 Nicholas Faiz, Tree Falling In The Woods Pty Ltd.
+
+
+Inkling code is copyrighted to Tree Falling In The Woods, Pty Ltd. and available under the MIT License.
+It includes software from other projects, other people, listed below, all available through the MIT license.
+
+* Ruby on Rails - http://rubyonrails.org - David Heinemeier Hansson, etc..
+* Enki - http://www.enkiblog.com/ - Xavier Shay. 
+
+The 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/app/controllers/inkling/admin/base_controller.rb

@@ -0,0 +1,5 @@
+class Inkling::Admin::BaseController < ApplicationController
+
+  layout 'inkling/manage'
+
+end

data/app/controllers/inkling/admin/content_types_controller.rb

@@ -0,0 +1,4 @@
+class Inkling::Admin::ContentTypesController < Inkling::Admin::BaseController
+  
+  def index; end
+end

data/app/controllers/inkling/admin/permissions_controller.rb

@@ -0,0 +1,4 @@
+class Inkling::Admin::PermissionsController < Inkling::Admin::BaseController
+  inherit_resources                                                                                     
+  defaults :resource_class => Inkling::Permission, :instance_name => 'inkling_permission'
+end

data/app/controllers/inkling/admin/roles_controller.rb

@@ -0,0 +1,4 @@
+class Inkling::Admin::RolesController < Inkling::Admin::BaseController
+  inherit_resources                                                                                     
+  defaults :resource_class => Inkling::Role, :instance_name => 'role'
+end

data/app/controllers/inkling/admin/users_controller.rb

@@ -0,0 +1,4 @@
+class Inkling::Admin::UsersController < Inkling::Admin::BaseController
+  inherit_resources                                                                                     
+  defaults :resource_class => Inkling::User, :instance_name => 'inkling_admin_user'
+end

data/app/controllers/inkling/base_controller.rb

@@ -0,0 +1,9 @@
+class Inkling::BaseController < ApplicationController
+  
+  alias current_user current_inkling_user
+  helper_method :current_user
+  before_filter :authenticate_inkling_user!
+
+  layout 'inkling/manage'
+
+end

data/app/controllers/inkling/content_controller.rb

@@ -0,0 +1,6 @@
+class Inkling::ContentController < ApplicationController
+
+  layout 'content' #this file is created by the Theme functionality in admin, and written out to tmp/inkling/themes/layouts
+  alias current_user current_inkling_user
+  helper_method :current_user
+end

data/app/controllers/inkling/home_controller.rb

@@ -0,0 +1,44 @@
+class Inkling::HomeController < Inkling::BaseController
+
+  layout 'inkling/manage'
+  helper_method :dashboard_partials
+    
+  # protected
+  #these methods would be better in a helper, but it seems helpers have issues loading from engines.
+  def render_dashboard_partials
+    for file in dashboard_partials
+    	render(:file => file)
+  	end
+  end
+  
+  
+  def dashboard_partials
+    partials = []
+
+    for engine in Rails.application.railties.engines
+      dashboard_partials = scan_path_for_dashboard_partial(engine)
+      partials += dashboard_partials if dashboard_partials.any?
+    end
+    
+    partials += scan_path_for_dashboard_partial(Rails.application)
+    
+    partials
+  end
+  
+  def scan_path_for_dashboard_partial(application)
+    partials = []
+    for path in application.paths.app.views
+      if path =~ /views/
+  	    if File.exist?("#{path}/inkling/home/")
+  		    for entry in Dir.entries("#{path}/inkling/home/")
+  			    if entry =~ /_dashboard\./
+  				    partials << "#{path}/inkling/home/#{entry}"		
+  			    end
+  		    end
+  	    end
+      end    
+    end
+    
+    partials
+  end
+end

data/app/controllers/inkling/paths_controller.rb

@@ -0,0 +1,31 @@
+class Inkling::PathsController < Inkling::BaseController
+  # load_and_authorize_resource
+
+  before_filter :get_root
+
+  def index
+    @content_types = Inkling::Content::Types.listed
+    @content_types ||= []
+    @path = Inkling::Path.new
+  end
+
+  def update_tree 
+    new_parent_id = params[:new_parent]
+    child_id = params[:child]
+    new_parent = Inkling::Path.find(new_parent_id)
+    child = Inkling::Path.find(child_id)
+    restriction = new_parent.restricts?(child)
+    if restriction[0]
+      @msg = restriction[1]
+    else
+      child.move_to_child_of new_parent
+      child.save
+      @msg = "Ok."
+    end
+  end
+
+  private
+  def get_root
+    @roots = Inkling::Path.find_all_by_parent_id(nil)
+  end
+end

data/app/controllers/inkling/proxying_controller.rb

@@ -0,0 +1,19 @@
+class Inkling::ProxyingController < Inkling::BaseController
+
+  def new
+    content_type = params[:content_type]
+    bits = content_type.split("::")
+    model_name = bits.last
+    @proxy_path = "new_inkling_content_types_#{model_name}_path".downcase
+    redirect_to eval(@proxy_path)
+  end
+
+  def edit
+    debugger
+    content_type = params[:content_type]
+    bits = content_type.split("::")
+    model_name = bits.last
+    @proxy_path = "new_inkling_content_types_#{model_name}_path".downcase
+    redirect_to eval(@proxy_path)
+  end
+end

data/app/controllers/inkling/themes_controller.rb

@@ -0,0 +1,4 @@
+class Inkling::ThemesController < Inkling::BaseController
+  inherit_resources                                                                                     
+  defaults :resource_class => Inkling::Theme, :instance_name => 'inkling_theme'
+end

data/app/controllers/inkling/users/confirmations_controller.rb

@@ -0,0 +1,3 @@
+class Inkling::Users::ConfirmationsController < Devise::ConfirmationsController 
+  layout 'inkling/content'
+end

data/app/controllers/inkling/users/passwords_controller.rb

@@ -0,0 +1 @@
+class Inkling::Users::PasswordsController < Devise::PasswordsController ; end

data/app/controllers/inkling/users/sessions_controller.rb

@@ -0,0 +1,5 @@
+class Inkling::Users::SessionsController < Devise::SessionsController
+
+  layout nil
+  
+end

data/app/models/inkling/can_can_action.rb

@@ -0,0 +1,5 @@
+class Inkling::CanCanAction < ActiveRecord::Base
+  set_table_name "inkling_can_can_actions"
+  has_one :permission
+  
+end

data/app/models/inkling/log.rb

@@ -0,0 +1,3 @@
+class Inkling::Log < ActiveRecord::Base
+  
+end

data/app/models/inkling/path.rb

@@ -0,0 +1,54 @@
+
+module Inkling  
+  #an associated object which tracks all the relative URL paths to content in the system
+  
+  class Path < ActiveRecord::Base
+    set_table_name :inkling_paths
+    
+    belongs_to :content, :polymorphic => true
+    has_many :permissions
+    belongs_to :parent, :class_name => "Path"
+    has_many :children, :class_name => "Path", :foreign_key => "parent_id"
+
+    before_validation :update_slug!
+    validate :slug_unique?
+
+
+    #called before adding a new child path to see if the content object restricts what it's path should nest
+    #if there isn't a restricts() impl. on the content object, false is returned, allowing anything to be nested
+    def restricts?(sub_path)
+      if self.content
+        self.content.restricts?(sub_path.content) if self.content.respond_to? :restricts?
+      else
+        false
+      end
+    end
+
+    def update_slug!
+      slug = self.parent ? "#{self.parent.slug}/" : "/"
+      slug += "#{self.content.title}"
+      self.slug = sluggerize(slug)
+    end
+
+    #stolen from enki
+    def sluggerize(slug)
+      slug.downcase!
+      slug.gsub!(/&(\d)+;/, '') # Ditch Entities
+      slug.gsub!('&', 'and') # Replace & with 'and'
+      slug.gsub!(/['"]/, '') # replace quotes by nothing
+      slug.gsub!(/\ +/, '-') # replace all white space sections with a dash
+      slug.gsub!(/(-)$/, '') # trim dashes
+      slug.gsub!(/^(-)/, '') # trim dashes
+      slug.gsub!(/[^\/a-zA-Z0-9\-]/, '-') # Get rid of anything we don't like
+      slug
+    end    
+        
+    def slug_unique?
+      pre_existing = Inkling::Path.find_by_slug(self.slug)
+
+      if pre_existing and (self.new_record? or (pre_existing.id != self.id))
+        self.errors.add("path (#{self.slug}) already taken by another object in this website ")
+      end
+    end
+  end
+end

data/app/models/inkling/permission.rb

@@ -0,0 +1,7 @@
+class Inkling::Permission < ActiveRecord::Base
+  set_table_name 'inkling_permissions'
+  
+  belongs_to :role
+  belongs_to :can_can_action
+  belongs_to :type  
+end

data/app/models/inkling/role.rb

@@ -0,0 +1,10 @@
+module Inkling
+  class Role < ActiveRecord::Base    
+    set_table_name 'inkling_roles'
+    has_many :role_memberships
+    has_many :users, :through => :role_memberships
+    has_many :permissions
+        
+    ADMIN = "administrator"
+  end
+end

data/app/models/inkling/role_membership.rb

@@ -0,0 +1,8 @@
+module Inkling
+  class RoleMembership < ActiveRecord::Base
+    set_table_name 'inkling_role_memberships'
+    
+    belongs_to :user, :class_name => "Inkling::User", :foreign_key => :user_id
+    belongs_to :role, :class_name => "Inkling::Role", :foreign_key => :role_id
+  end
+end

data/app/models/inkling/theme.rb

@@ -0,0 +1,74 @@
+#maintain one record which will theme the entire site for now
+
+class Inkling::Theme < ActiveRecord::Base
+  include FileUtils
+  set_table_name "inkling_themes"
+
+  validates_uniqueness_of :name
+  
+  after_save :check_init
+  after_save :write_file
+  after_destroy :delete_file
+
+    @@default_content = <<-DEFAULT
+  <html>
+  <head>
+    <title>Your Inkling CMS</title>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <meta name="keywords" content="" />
+    <meta name="description" content="" />
+  </head>
+  <body>
+
+  This is the default theme for public users to view content on your site. <br/>
+  
+  An administrator should log into Inkling Administration and configure the 'content' theme. <br/>
+
+  <div class="notice"><%= notice %></div>
+  <div class="alert"><%= alert %></div>
+
+  <div id="page">
+    <div id="main">
+        <%= yield %> 
+    </div>
+  </div>
+
+  <div id="footer">
+    <span id="version" align='center'>Inkling version <%= Inkling::VERSION %></span>
+  </div>
+
+
+  </body>
+  </html>
+      DEFAULT
+
+  def self.content
+    if Inkling::Theme.find_by_name("content").nil?
+      self.create!(:name => "content", :body =>  @@default_content)
+    end
+    
+    Inkling::Theme.find_by_name("content")
+  end
+
+  def self.site_theme_file
+    "#{Inkling::THEME_LAYOUTS_DIR}#{self.site.file_name}"
+  end
+    
+  def write_file
+    File.open("#{Inkling::THEME_LAYOUTS_DIR}#{self.file_name}", "w") {|f| f.write(self.body)}
+  end
+  
+  def check_init
+    mkdir(Inkling::TMP_DIR) unless File.exist?(Inkling::TMP_DIR)
+    mkdir("#{Inkling::THEMES_DIR}") unless File.exist?("#{Inkling::THEMES_DIR}") 
+    mkdir("#{Inkling::THEME_LAYOUTS_DIR}") unless File.exist?("#{Inkling::THEME_LAYOUTS_DIR}") 
+  end
+  
+  def delete_file
+    rm("#{Inkling::THEME_LAYOUTS_DIR}#{self.file_name}")
+  end
+  
+  def file_name
+    "#{self.name}#{self.extension}"
+  end
+end

data/app/models/inkling/type.rb

@@ -0,0 +1,4 @@
+class Inkling::Type < ActiveRecord::Base
+  set_table_name "inkling_types"
+  has_one :permission
+end

data/app/models/inkling/user.rb

@@ -0,0 +1,16 @@
+class Inkling::User < ActiveRecord::Base
+  
+  set_table_name 'inkling_users' 
+  has_many :role_memberships
+  has_many :roles, :through => :role_memberships
+  
+  devise :database_authenticatable, :recoverable, :rememberable, :trackable, :validatable    
+  
+  # Setup accessible (or protected) attributes for your model
+  attr_accessible :email, :password, :password_confirmation, :remember_me
+  
+  def has_role?(role)
+    role = role.to_s
+    self.roles.find_by_name(role)
+  end
+end

data/app/views/inkling/admin/permissions/_form.html.erb

@@ -0,0 +1,15 @@
+<% if @inkling_admin_permission.errors.any? %>
+    <h2><%= pluralize(@inkling_admin_permission.errors.count, "error") %> prohibited this permission from being saved:</h2>
+    <ul>
+    <% @inkling_admin_permission.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <% end %>
+    </ul>
+<% end %>
+
+<% semantic_form_for [@inkling_admin_permission] do |form| %>
+  
+  <% form.buttons do %>
+    <%= form.commit_button %>
+  <% end %>
+<% end %>

data/app/views/inkling/admin/permissions/edit.html.erb

@@ -0,0 +1 @@
+<%= render(:partial => "form") %>

data/app/views/inkling/admin/permissions/index.html.erb

@@ -0,0 +1,26 @@
+<%= semantic_form_for @inkling_admin_permission do |f| %>
+  <%= f.input :role, :as => :select %>
+  <%= f.input :content_type, :as => :select %>
+
+  <% form.buttons do %>
+    <%= form.commit_button %>
+  <% end %>
+<% end %>
+
+
+<p/>
+<table id="permissions-table">
+  <tr>
+    <th>Action</th>
+    <th>Type</th>
+    <th>Role</th>
+  </tr>
+  <% for permission in @permissions %>
+    <tr>
+      <td><%= permission.action %></td>
+      <td><%= permission.content_type %></td>
+      <td><%= permission.role.name %></td>
+    </tr>  
+  <% end %>
+</table>
+

data/app/views/inkling/admin/permissions/new.html.erb

@@ -0,0 +1 @@
+<%= render(:partial => "form") %>

data/app/views/inkling/admin/permissions/show.html.erb

@@ -0,0 +1,11 @@
+<table>
+<% @inkling_admin_permission.attributes.each do |a| %>
+  <tr>
+    <th><%= a[0] %></th>
+    <td><%= a[1] %></td>
+  </tr>
+<% end %>
+</table>
+
+<p><%= link_to "Edit", edit_polymorphic_path(@inkling_admin_permission) %></p>
+<p><%= link_to "Back", polymorphic_path(@inkling_admin_permission) %></p>

data/app/views/inkling/admin/roles/index.html.erb

@@ -0,0 +1,3 @@
+<% for role in @roles %>
+  <%= role.name %> <br/>
+<% end %>

data/app/views/inkling/admin/sites/index.html.erb

@@ -0,0 +1 @@
+index of sites

data/app/views/inkling/admin/types/index.html.erb

@@ -0,0 +1,12 @@
+Content Types installed: <%= Inkling::Types::Register.listed.size %> 
+<p>
+
+<% for type in Inkling::Types::Register.listed %>
+  <%= type.friendly_name %> - <%= type %> <br/>
+<% end %>
+
+<p>
+  
+Paths: <%= Inkling::Path.all.size %>
+
+<p>

data/app/views/inkling/admin/users/_form.html.erb

@@ -0,0 +1,16 @@
+<% if @inkling_admin_user.errors.any? %>
+    <h2><%= pluralize(@inkling_admin_user.errors.count, "error") %> prohibited this user from being saved:</h2>
+    <ul>
+    <% @inkling_admin_user.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <% end %>
+    </ul>
+<% end %>
+
+<% semantic_form_for [@inkling_admin_user] do |form| %>
+  <%= form.input :email %>
+  
+  <% form.buttons do %>
+    <%= form.commit_button %>
+  <% end %>
+<% end %>

data/app/views/inkling/admin/users/edit.html.erb

@@ -0,0 +1 @@
+<%= render(:partial => "form") %>