inkling 0.0.3a

data/lib/inkling/engine.rb

@@ -0,0 +1,35 @@
+require "inkling"
+require "inkling/types"
+require "inkling/version"
+require "inkling/slugs"
+require "inkling/routing"
+require 'cancan'
+require "inkling/ability"
+require "devise"
+require 'devise/orm/active_record'
+
+require "rails"
+
+module Inkling
+  TMP_DIR = "tmp/inkling/"
+  THEMES_DIR = "#{TMP_DIR}themes/"
+  THEME_LAYOUTS_DIR = "#{THEMES_DIR}layouts/"
+  BOOTSTRAP_TASKS = []
+  
+  class Engine < Rails::Engine
+    config.inkling = Inkling
+        
+    initializer "static assets" do |app|
+      app.middleware.insert_after ::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public"
+    end
+  end
+  
+  WELCOME_MSG = <<-MSG
+
+Welcome!
+Inkling was bootstrapped at #{Time.now}.
+Start the server ('rails server') then visit http://localhost:3000/inkling/users/sign_in. 
+Use the default admin account admin@localhost.com/test123.
+
+  MSG
+end

data/lib/inkling/routing.rb

@@ -0,0 +1,26 @@
+require 'ruby-debug'
+module Inkling
+  module Routing
+    class TypeConstraint
+      attr_accessor :type
+
+      def initialize(type, prefix = nil)
+        @type = type
+        @prefix = prefix
+      end
+
+      def matches?(request)
+        path = @prefix.nil? ? request.path : request.path.gsub(@prefix, "")
+        matching_path = Inkling::Path.find_by_slug(path)
+
+        if matching_path
+          result = matching_path.content.is_a? @type.constantize
+          request.params[:id] = matching_path.content.id
+          result
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/inkling/slugs.rb

@@ -0,0 +1,17 @@
+module Inkling
+  module Slugs
+    #copied from enki see http://www.enkiblog.com/  
+    def sluggerize(slug)
+      text = slug.dup
+      text.downcase!
+      text.gsub!(/&(\d)+;/, '') # Ditch Entities
+      text.gsub!('&', 'and') # Replace & with 'and'
+      text.gsub!(/['"]/, '') # replace quotes by nothing
+      text.gsub!(/\ +/, '-') # replace all white space sections with a dash
+      text.gsub!(/(-)$/, '') # trim dashes
+      text.gsub!(/^(-)/, '') # trim dashes
+      text.gsub!(/[^\/a-zA-Z0-9\-]/, '-') # Get rid of anything we don't like
+      text
+    end
+  end
+end

data/lib/inkling/types.rb

@@ -0,0 +1,61 @@
+module Inkling
+  module Types
+    module ActsAs
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def acts_as_inkling(friendly_name = self.class.name)
+
+          Inkling::Types::Register.register(self)
+          cattr_accessor :friendly_name
+          self.friendly_name = (friendly_name or self)
+          has_one :path, :as => :content, :dependent => :destroy, :class_name => "Inkling::Path"
+          after_create :create_path
+          after_update :update_path
+        
+          send :include, InstanceMethods
+        end
+      end
+    end
+
+    module InstanceMethods
+      #Creates a path to represent the ContentType instance; the path is used for routing, etc..
+      def create_path
+        path = Inkling::Path.new
+        path.content = self
+        path.save!
+      end
+    
+      def update_path
+        self.path.update_slug!
+        self.path.save!
+      end
+    end
+
+    class Register
+      def self.listed
+        @listed ||= [] 
+      end
+    
+      def self.keys
+        @keys ||= []
+      end
+    
+      def self.register(type)
+        if keys.include?(type.name)
+          flush!
+        end
+      
+        keys << type.name
+        listed << type unless listed.index(type)
+      end      
+    
+      def self.flush!
+        @keys = []
+        @listed = []
+      end
+    end
+  end
+end

data/lib/inkling/util/migration_helpers.rb

@@ -0,0 +1,22 @@
+module Inkling
+  module Util
+    module MigrationHelpers
+      def add_foreign_key(from_table, from_column, to_table)
+        constraint_name = "fk_#{from_table}_#{from_column}"
+
+        execute %{alter table #{from_table}
+                  add constraint #{constraint_name}
+                  foreign key (#{from_column})
+                  references #{to_table}(id)}
+      end
+
+
+      def remove_foreign_key(from_table, from_column)
+        constraint_name = "fk_#{from_table}_#{from_column}"
+
+        execute %{alter table #{from_table}
+                   drop foreign key #{constraint_name}}
+      end
+    end
+  end
+end

data/lib/inkling/version.rb

@@ -0,0 +1,3 @@
+module Inkling
+  VERSION = "0.0.3a"
+end

data/lib/inkling.rb

@@ -0,0 +1,3 @@
+require 'inkling/engine' if defined?(Rails)
+
+

data/lib/tasks/cucumber.rake

@@ -0,0 +1,53 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a 
+# newer version of cucumber-rails. Consider adding your own code to a new file 
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :cucumber do
+    Cucumber::Rake::Task.new({:ok => 'db:test:prepare'}, 'Run features that should pass') do |t|
+      t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'default'
+    end
+
+    Cucumber::Rake::Task.new({:wip => 'db:test:prepare'}, 'Run features that are being worked on') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'wip'
+    end
+
+    Cucumber::Rake::Task.new({:rerun => 'db:test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'rerun'
+    end
+
+    desc 'Run all features'
+    task :all => [:ok, :wip]
+  end
+  desc 'Alias for cucumber:ok'
+  task :cucumber => 'cucumber:ok'
+
+  task :default => :cucumber
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end

data/lib/tasks/inkling.rake

@@ -0,0 +1,48 @@
+namespace :inkling do
+
+  desc "Boostraps (calls generators, creates databases, runs migrations, seeds the database) Inkling"
+  task :bootstrap => ["environment", "inkling:generate", "inkling:run_bootstrap_tasks", "db:create", "db:migrate", "inkling:init", "inkling:welcome_msg"]
+
+  desc "Wipes migrations dir Hard reset (caveat raker), then bootstrap. Destroys db, recreates it, regenerates all migrations, migrates, and initializes with inkling data"
+  task :rebuild => ["environment", "inkling:destroy_migrations", "db:drop", "inkling:bootstrap"]
+
+
+  desc "Runs system('rm -rf db/migrate/*')"
+  task :destroy_migrations do 
+    system("rm -rf db/migrate/*")
+  end
+  
+  
+  desc "Runs system('rails generate inkling')"
+  task :generate do
+    system("rails generate inkling")    
+  end
+  
+  desc "Iterates through array Inkling::REBUILD_TASKS and executes each task it finds (useful to add your bootstrap sequence to inkling:rebuild)"
+  task :run_bootstrap_tasks do
+    for task in Inkling::BOOTSTRAP_TASKS
+      Rake::Task[task].execute
+    end
+  end
+
+  desc "Create a default user with login 'admin' and password 'admin'"
+  task :default_admin => [:environment] do
+    user = Inkling::User.create!(:email => "admin@localhost.com", :password => "test123", :password_confirmation => "test123")
+    Inkling::RoleMembership.create!(:user => user, :role => Inkling::Role.find_by_name(Inkling::Role::ADMIN))
+    puts "Inkling> Created default administrator: login - 'admin@localhost.com', password - 'test123'."
+  end
+
+  desc "Initializes inkling data."
+  task :init => [:environment] do
+    Inkling::Role.create!(:name => Inkling::Role::ADMIN)
+    Rake::Task["inkling:default_admin"].execute
+    puts "Inkling> Created administrator role."
+  end
+  
+  task :welcome_msg do
+    puts Inkling::WELCOME_MSG
+  end
+  
+  desc "Runs specs and cukes."
+  task :megatest => [:environment, :spec, :cucumber]
+end

data/lib/tasks/rspec.rake

@@ -0,0 +1,68 @@
+begin
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+rescue MissingSourceFile
+  module Rspec
+    module Core
+      class RakeTask
+        def initialize(name)
+          task name do
+            # if rspec-rails is a configured gem, this will output helpful material and exit ...
+            require File.expand_path(File.dirname(__FILE__) + "/../../config/environment")
+
+            # ... otherwise, do this:
+            raise <<-MSG
+
+#{"*" * 80}
+*  You are trying to run an rspec rake task defined in
+*  #{__FILE__},
+*  but rspec can not be found in vendor/gems, vendor/plugins or system gems.
+#{"*" * 80}
+MSG
+          end
+        end
+      end
+    end
+  end
+end
+
+Rake.application.instance_variable_get('@tasks').delete('default')
+
+spec_prereq = Rails.root.join('config', 'database.yml').exist? ? "db:test:prepare" : :noop
+task :noop do
+end
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+Rspec::Core::RakeTask.new(:spec => spec_prereq)
+
+namespace :spec do
+  [:requests, :models, :controllers, :views, :helpers, :mailers, :lib].each do |sub|
+    desc "Run the code examples in spec/#{sub}"
+    Rspec::Core::RakeTask.new(sub => spec_prereq) do |t|
+      t.pattern = "./spec/#{sub}/**/*_spec.rb"
+    end
+  end
+
+  task :statsetup do
+    require 'rails/code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models) if File.exist?('spec/models')
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views) if File.exist?('spec/views')
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers) if File.exist?('spec/controllers')
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/helpers) if File.exist?('spec/helpers')
+    ::STATS_DIRECTORIES << %w(Library\ specs spec/lib) if File.exist?('spec/lib')
+    ::STATS_DIRECTORIES << %w(Mailer\ specs spec/mailers) if File.exist?('spec/mailers')
+    ::STATS_DIRECTORIES << %w(Routing\ specs spec/routing) if File.exist?('spec/routing')
+    ::STATS_DIRECTORIES << %w(Request\ specs spec/requests) if File.exist?('spec/requests')
+    ::CodeStatistics::TEST_TYPES << "Model specs" if File.exist?('spec/models')
+    ::CodeStatistics::TEST_TYPES << "View specs" if File.exist?('spec/views')
+    ::CodeStatistics::TEST_TYPES << "Controller specs" if File.exist?('spec/controllers')
+    ::CodeStatistics::TEST_TYPES << "Helper specs" if File.exist?('spec/helpers')
+    ::CodeStatistics::TEST_TYPES << "Library specs" if File.exist?('spec/lib')
+    ::CodeStatistics::TEST_TYPES << "Mailer specs" if File.exist?('spec/mailer')
+    ::CodeStatistics::TEST_TYPES << "Routing specs" if File.exist?('spec/routing')
+    ::CodeStatistics::TEST_TYPES << "Request specs" if File.exist?('spec/requests')
+  end
+end

data/spec/controllers/inkling/proxying_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Inkling::ProxyingController do
+
+  it "should assemble a resource route and proxy onto it" do
+    post 'proxy', {:content_type =>  "Inkling::Foo"}
+    response.redirect_url.should eql "http://test.host/inkling/content_types/foo/new"
+  end
+end

data/spec/models/path_spec.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Inkling::Path do
+
+  # let(:foo) {ContentTypes::Foo.create(:name => "1")}
+  # 
+  # it "should update the path based on its parent" do
+  #   foo2 = ContentTypes::Foo.create(:name => "2")
+  #   foo2.path.move_to_child_of foo.path  
+  #   foo2.save  
+  #   foo2.path.slug.should == "/1/2"
+  # end
+end

data/spec/models/permission_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Inkling::Permission do
+  let(:type) {Inkling::Type.create!(:klass_name => "String")}
+  let(:user) {Inkling::User.create!(:email => "admin@localhost.com", :password => "test123", :password_confirmation => "test123")}  
+
+  it "should let an administrator have automatic manage permission over foo" do    
+    create_role_and_membership(Inkling::Role::ADMIN, user)
+
+    ability = Inkling::Ability.new(user)
+    ability.can?(:manage, String).should be_true
+  end
+  
+  it "should apply CanCanAction based perm.s via the role to the user on the type" do
+    role = create_role_and_membership("content_editor", user)
+    update_action = Inkling::CanCanAction.create!(:name => "update")
+    foo_update_permission = Inkling::Permission.create(:role_id => role.id, :can_can_action_id => update_action.id, :type_id => type.id)
+    ability = Inkling::Ability.new(user)
+    ability.can?(:update, String).should be_true
+    ability.cannot?(:delete, String).should be_true    
+  end
+  
+  
+  def create_role_and_membership(role_name, user)
+    role = Inkling::Role.create(:name => role_name)
+    membership = Inkling::RoleMembership.create!(:user => user, :role => role) 
+    role
+  end
+end

data/spec/models/theme_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Inkling::Theme do
+  
+  default = <<-DEFAULT
+<html>
+<head>
+  <title>Inkling Administration</title>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+  <meta name="keywords" content="" />
+  <meta name="description" content="" />
+</head>
+<body>
+
+
+<div id="header">
+	<div id="logo">
+		<h1><%= link_to 'Inkling', inkling_user_root_path %></h1>
+	</div>
+	<div id="tabs">
+		<%= link_to 'Home', inkling_user_root_path %> | <%= link_to 'Tree', inkling_paths_path %>
+	</div>
+</div>
+
+<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
+      
+  let(:theme) {Inkling::Theme.create!(:name => "default", :body => default)}
+  
+  it "should write the theme to the tmp/inkling/themes directory" do
+    theme
+    lines = []
+    file = File.open("tmp/inkling/themes/#{theme.file_name}", "rb")
+    contents =  file.read
+    
+    file_words = contents.split(/\W/)
+    theme_words = theme.body.split(/\W/)
+    file_words.size.should == theme_words.size
+
+    i = 0
+    for word in theme_words
+      word.should == file_words[i]
+      i += 1
+    end
+  end
+  
+  it "should delete the file when the theme model is deleted" do
+    theme.destroy
+    File.exist?("tmp/inkling/themes/#{theme.file_name}").should be_false  
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# This file is copied to ~/spec when you run 'ruby script/generate rspec'
+# from the project root directory.
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment") #nf patching generated spec_helper
+#require File.dirname(__FILE__) + "/../config/environment" unless defined?(Rails)
+require 'rspec/rails'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+Rspec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # If you'd prefer not to run each of your examples within a transaction,
+  # uncomment the following line.
+  # config.use_transactional_examples = false
+  config.use_transactional_examples = true
+end

data/spec/support/devise.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include Devise::TestHelpers, :type => :controller
+end

data/spec/support/inkling_spec_helper.rb

@@ -0,0 +1 @@
+require 'ruby-debug'