kilt-cms 0.9.13 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cea124fc5db8137e9f0977072b63f52893b67786
-  data.tar.gz: 1c77d6e7b5c6ab5345c63902f470acf4593be569
+  metadata.gz: 92e36981513be1d52296ed4d4321e194a104c4dc
+  data.tar.gz: a6d90b7b31ef3246fa406a754dec05943469c030
 SHA512:
-  metadata.gz: e6484b3682a25da1da72328fd7637479421719c1fa3232d6725d29a03d85fedf20fc1564ea6e3de031bd93dc2358c7fa0396718b072639e28fb62e975f8386b6
-  data.tar.gz: a8c0440e8c765a0c4319a50908acf1ce378b4127f0f5027030f8a9636eb1c5a97f8b759786f1a451aa7f8b08752e1da567d475a894c3d2e59528d98e5e710e9e
+  metadata.gz: f4ab8a4e06b2a8c2b979040006f8d39557e1c091b9521e7293ee9d8bce710b7e6b9e3a1c84a29c6173cb05f1220ebbf0cc9cea9be12be35df0231c23fda782f4
+  data.tar.gz: 7a13dd0365393f397a46c328f40f77c0f416f4f3fd04662ebe1d55fa96f975492b7da31c405a4f41e560d282973c6bb2b54229fb5395859439022107360c253c

data/README.rdoc

@@ -25,13 +25,11 @@ Note: We're trying to find a way around that last step, but for now we're just e
 - Run the Kilt generator:
 
     $ rails g kilt:install
-    
-- Create a creds file:
 
-    $ mv config/kilt/creds.yml.example config/kilt/creds.yml
+If you would like to use RethinkDB as your datastore, you'll need to copy the rethinkdb example. Add your database info to the creds.yml. You should have a RethinkDB set up and running already.
+ 
+    $ mv config/kilt/creds.yml.rethinkdb.example config/kilt/creds.yml
     
-- Add your database info to the creds.yml. You should have a RethinkDB set up and running already.
-
 - If you want to use S3 for your image and file uploads, add your S3 info to creds.yml. Also set the following in your config.yml:
 
     storage:

data/app/controllers/kilt/kilt_controller.rb

@@ -114,7 +114,7 @@ module Kilt
     private
     
     def ensure_config
-      if Kilt.config.empty? || !Kilt.config.db
+      unless Kilt::Utils.config_is_valid?
         lines = []
         lines << '<pre>'
         lines << 'The Kilt gem has been installed, but you haven\'t configured it yet.'

data/app/views/kilt/form/{file.html.erb → _file.html.erb}

@@ -3,7 +3,7 @@
 
     <% if object["#{field_name}"] && object["#{field_name}"] != '' %>
         <div class="filename">
-            <span><%= link_to object["#{field_name}"], Kilt::Utils.download_location(field_name, object["#{field_name}"]), :target => '_blank' %>
+            <span><%= link_to object["#{field_name}"], Kilt::Utils.download_location('file', object["#{field_name}"]), :target => '_blank' %>
             <a class="button delete <% if !object["#{field_name}"] || object["#{field_name}"] == "" %>hidden<% end %>">Reset/remove file</a></span>
         </div>
     <% end %>

data/app/views/kilt/form/{image.html.erb → _image.html.erb}

@@ -4,7 +4,7 @@
     <% if object["#{field_name}"] && object["#{field_name}"] != '' %>
         <div id="image-container-<%= index %>">
             <div id="image-<%= index %>">
-                <%= image_tag Kilt::Utils.download_location(field_name, object["#{field_name}"]), :width => '100%' %>
+                <%= image_tag Kilt::Utils.download_location('image', object["#{field_name}"]), :width => '100%' %>
             </div>
             <div>
                 <a id="image-reset-<%= index%>" class="button delete <% if !object["#{field_name}"] || object["#{field_name}"] == "" %>hidden<% end %>">Reset/remove image</a>

data/app/views/kilt/kilt/_form.html.erb

@@ -2,18 +2,15 @@
 <div class="wr">
 
     <% 
-        if Kilt.send(@type).name != nil
-            name = Kilt.send(@type).name
-        else
-            name = @type.pluralize.capitalize
-        end
+        singular = Kilt::Formatting.singular_name_of @type
+        plural   = Kilt::Formatting.plural_name_of @type
     %>
     
-    <h2><%= @object['name'] %> <small><%= name.singularize.capitalize %></small></h2>
+    <h2><%= @object['name'] %> <small><%= singular %></small></h2>
 
     <div class="page-actions">
-        <%= link_to "← Back to #{name}", list_path(@type), :class => 'button back' %>
-        <%= link_to "New #{@type.capitalize}", new_object_path(@type), :class => 'button back' if !@object.empty? %>
+        <%= link_to "← Back to #{plural}", list_path(@type), :class => 'button back' %>
+        <%= link_to "New #{singular}", new_object_path(@type), :class => 'button back' if !@object.empty? %>
     </div>
 
     <% if flash[:error] -%>
@@ -27,7 +24,12 @@
     <%= form_tag @path, :method => "post", :multipart => true do %>
 
         <% @object.fields.each_with_index do |(key, value), index| %>
-            <%= Kilt::Form.prep_field(value, @object, key, index) %>
+            <%= Kilt::Form.render_field(self, {
+                                                key: key,
+                                                value: value,
+                                                object: @object,
+                                                index: index
+                                              } ) %>
         <% end %>
 
         <div class="form-input actions">
@@ -36,4 +38,4 @@
 
     <% end%>
 
-</div>
+</div>

data/app/views/kilt/kilt/edit.html.erb

@@ -1,2 +1,2 @@
 <% @path = update_object_path(@type.pluralize, @slug) %>
-<%= render :partial => 'form' %>
+<%= render :partial => 'form' %>

data/app/views/kilt/kilt/index.html.erb

@@ -2,8 +2,9 @@
     <h2>Dashboard</h2>
 
     <ul class="object-list">
-        <% @types.each do |type, name| %>
+        <% @types.each do |type, _| %>
+            <% name = Kilt::Formatting.plural_name_of(type) %>
             <li><%= link_to name, list_path(type.pluralize) %></li>
         <% end %>
     </ul>
-</div>
+</div>

data/app/views/kilt/kilt/list.html.erb

@@ -1,17 +1,14 @@
 <div class="wr">
 
     <% 
-        if Kilt.send(@type).name != nil
-            name = Kilt.send(@type).name
-        else
-            name = @type.pluralize.capitalize
-        end
+        singular = Kilt::Formatting.singular_name_of @type
+        plural   = Kilt::Formatting.plural_name_of @type
     %>
 
-    <h2><%= name %></h2>
+    <h2><%= plural %></h2>
 
     <div class="page-actions">
-        <%= link_to "New #{name.singularize.capitalize}", new_object_path(@type.singularize), :class => 'button' %>
+        <%= link_to "New #{singular}", new_object_path(@type.singularize), :class => 'button' %>
     </div>
 
     <!-- todo: search by title -->
@@ -26,7 +23,7 @@
 
     <% if @objects.empty? %>
 
-        No <%= name %> found.
+        No <%= plural %> found.
 
     <% else %>
 
@@ -72,4 +69,4 @@
 
     <% end %>
 
-</div>
+</div>

data/app/views/kilt/kilt/new.html.erb

@@ -1,2 +1,2 @@
 <% @path = create_object_path(@type.pluralize) %>
-<%= render :partial => 'form' %>
+<%= render :partial => 'form' %>

data/app/views/layouts/kilt/cms/_menu.html.erb

@@ -4,13 +4,9 @@
         <a class="button small dashboard" href="<%= kilt_engine.root_path %>">Dashboard</a>
         <% Kilt.types.each do |type| %>
           <% 
-              if Kilt.send(type).name != nil
-                  name = Kilt.send(type).name
-              else
-                  name = type.pluralize.capitalize
-              end
+              plural   = Kilt::Formatting.plural_name_of type
           %>
-          <%= link_to name, list_path(type.pluralize), class: "button small dashboard" %>
+          <%= link_to plural, list_path(type.pluralize), class: "button small dashboard" %>
         <% end %>
     </div>
 </header>

data/lib/generators/kilt/backend_generator.rb

@@ -7,14 +7,36 @@ module Kilt
       source_root File.expand_path("../templates/backend", __FILE__)
       
       def generate
-        
-        #copy files, templates for app-specific naming, inject engine mount to routes
+        add_the_config_file
+        add_the_credential_file_examples
+        add_the_database_migration_file
+        add_the_kilt_routes
+        add_the_initializer
+      end
+
+      private
+
+      def add_the_config_file
         template 'config.yml.erb', Rails.root.join('config', 'kilt', 'config.yml')
-        copy_file 'creds.yml.example', Rails.root.join('config', 'kilt', 'creds.yml.example')
+      end
+
+      def add_the_credential_file_examples
+        copy_file 'creds.yml.example', Rails.root.join('config', 'kilt', 'creds.yml')
+        copy_file 'creds.yml.rethinkdb.example', Rails.root.join('config', 'kilt', 'creds.yml.rethinkdb.example')
+      end
+
+      def add_the_database_migration_file
+        copy_file 'create_kilt_objects.rb', Rails.root.join('db', 'migrate', Time.now.strftime("%Y%m%d%H%M%S") + "_create_kilt_objects.rb")
+      end
+
+      def add_the_kilt_routes
+        inject_into_file Rails.root.join('config', 'routes.rb'), "\n\tmount Kilt::Engine => '/admin', as: 'kilt_engine'\n", :after => ".routes.draw do\n"
+      end
+
+      def add_the_initializer
         copy_file 'kilt.rb', Rails.root.join('config', 'initializers', 'kilt.rb')
-        inject_into_file Rails.root.join('config', 'routes.rb'), "\n\tmount Kilt::Engine => '/admin', as: 'kilt_engine'\n", :after => "#{Rails.application.class.parent_name.camelize}::Application.routes.draw do\n"
-      
       end
+
     end
   end
-end
+end

data/lib/generators/kilt/templates/backend/create_kilt_objects.rb

@@ -0,0 +1,13 @@
+class CreateKiltObjects < ActiveRecord::Migration
+  def change
+    create_table :kilt_objects do |t|
+      t.string :unique_id
+      t.string :name
+      t.string :object_type
+      t.string :slug
+      t.text :data
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/kilt/templates/backend/creds.yml.example

@@ -1,11 +1,16 @@
-db:
-  host: <DB host>
-  port: <DB port>
-  db: <DB database>
+test:
+  db:
+    type: active_record
+development:
+  db:
+    type: active_record
+production:
+  db:
+    type: active_record
 s3:
   key: <S3 key>
   secret: <S3 secret>
   bucket: <S3 bucket>
 auth:
   username: <Username>
-  password: <Password>
+  password: <Password>

data/lib/generators/kilt/templates/backend/creds.yml.rethinkdb.example

@@ -0,0 +1,22 @@
+test:
+  db:
+    host: 127.0.0.1
+    port: 28015
+    db: my_app_test
+development:
+  db:
+    host: 127.0.0.1
+    port: 28015
+    db: my_app_development
+production:
+  db:
+    host: ENV['KILT_HOST']
+    port: ENV['KILT_PORT']
+    db: ENV['KILT_DB']
+s3:
+  key: <S3 key>
+  secret: <S3 secret>
+  bucket: <S3 bucket>
+auth:
+  username: <Username>
+  password: <Password>

data/lib/kilt.rb

@@ -1,4 +1,5 @@
 require "kilt/base"
+require_relative "kilt_object"
 
 # Include the Rethink shortcut module, which will among other things instantiate a new
 # Rethink object (as "r") if needed
@@ -38,20 +39,11 @@ module Kilt
   # Example: Kilt.create(object)
   def self.create(object)
     object['created_at'] = object['updated_at'] = Time.now
-    object['unique_id'] = "#{(Time.now.to_f * 1000).to_i}"
-    result = Utils.db do
-      
-      # Check for slug uniqueness
-      results = r.db(Kilt.config.db.db).table('objects').filter({'slug' => "#{object['slug'].to_s}"}).run
-      if results.to_a.length > 0
-        object['slug'] = "#{object['slug']}-#{(Time.now.to_f * 1000).to_i}"
-      end
-      
-      # Insert the record
-      r.db(Kilt.config.db.db).table('objects').insert(object.values).run
-      
-    end
-    (result['errors'] == 0)
+    object['unique_id']  = "#{(Time.now.to_f * 1000).to_i}"
+    object['type']       = object.instance_eval { @type }
+    object['slug']       = slug_for object
+
+    Utils.database.create object
   end
 
   # Update an object
@@ -59,52 +51,25 @@ module Kilt
   # Example: Kilt.update(object)
   def self.update(slug, object)
     object['updated_at'] = Time.now
-    result = Utils.db do
-      
-      # Keep the original slug handy
-      results = r.db(Kilt.config.db.db).table('objects').filter({'slug' => "#{slug}"}).limit(1).run
-      original = results.to_a.first['unique_id']
-      
-      # Check for slug uniqueness
-      results = r.db(Kilt.config.db.db).table('objects').filter({'slug' => "#{object['slug']}"}).run
-      if results
-        result = results.to_a.first
-        if result && result['unique_id'] != original
-          object['slug'] = "#{Kilt::Utils.slugify(object['name'])}-#{(Time.now.to_f * 1000).to_i}"
-        end
-      end
-      
-      # Update the record
-      r.db(Kilt.config.db.db).table('objects').filter({'unique_id' => "#{original}"}).update(object.values).run
-      
-    end
-    (result['errors'] == 0)
-  end
+    object['slug']       = slug_for object
 
+    Utils.database.update object
+  end
 
   # Delete an object
   # Returns: boolean
   # Example: Kilt.delete('some-object')
   def self.delete(slug)
-    result = Utils.db do
-      r.db(Kilt.config.db.db).table('objects').filter({'slug' => "#{slug.to_s}"}).delete().run
-    end
-    (result['errors'] == 0)
+    Utils.database.delete slug
   end
 
   # Get the content for a specific object
   # Returns: Kilt::Object instance
   # Example: Kilt.object('big-event')
   def self.get(slug)
-    # connect to the db, get the object, close the connection, return the object
-    values = Utils.db do
-      r.db(Kilt.config.db.db).table('objects').filter({'slug' => "#{slug.to_s}"}).run
-    end
-    
-    result = values.to_a.first
-    
-    # create an object and return it
-    Kilt::Object.new(result['type'], result)
+    result = Utils.database.find(slug)
+    result ? Kilt::Object.new(result['type'], result)
+           : nil
   end
   
   # Get a list of objects
@@ -112,13 +77,28 @@ module Kilt
   # Example: Kilt.objects('events')
   # Used directly or via method_missing
   def self.get_collection(object_type)
-    # connect to the db, get the date, close the connection, return the array
-    results = Utils.db do
-      r.db(Kilt.config.db.db).table('objects').filter({'type' => "#{object_type.singularize.to_s}"}).run
+    results = Utils.database.find_all_by_type object_type
+    Kilt::ObjectCollection.new results
+  end
+
+  class << self
+
+    private
+
+    def slug_is_unique_for? slug, object
+      result = Utils.database.find(slug)
+      return true if result.nil?
+
+      "#{result['unique_id']}" == "#{object['unique_id']}"
     end
-    
-    # create an object collection
-    Kilt::ObjectCollection.new(results.to_a)
+
+    def slug_for object
+      slug = object['slug'].to_s.strip == '' ? Utils.slugify(object['name'])
+                                             : "#{object['slug']}"
+      slug_is_unique_for?(slug, object) ? slug
+                                        : "#{slug}-#{(Time.now.to_f * 1000).to_i}"
+    end
+
   end
 
 end

data/lib/kilt/base.rb

@@ -6,7 +6,8 @@ require "kilt/object_collection"
 
 require 'kilt/upload'
 
+require "kilt/db/rethink_db"
+require "kilt/db/active_record"
 require "kilt/utils"
 require "kilt/form"
-
-r = RethinkDB::RQL.new
+require "kilt/formatting"