canyon 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36a8f1d8684684e4323ac062af0294d15e24153a
-  data.tar.gz: 675bdcb88f2151e34d525e5f0913a9978128ed11
+  metadata.gz: e704d24cc230eb034c517bdecfdcc276298b892f
+  data.tar.gz: 5c39a46842f7b9e02d1306de1a3812b49925e888
 SHA512:
-  metadata.gz: c5b2473b776ae3965fa0ffb8f4f975971c331ba861d186da32aa7f51c3b1beedc186d64928f2239f00786cc7091c1b38ba367a057a341cb32e1c300fd4e4bdfe
-  data.tar.gz: 9ab5818e3dfe53e2aaf40c2d64e4a6f52d3f7da321d2f8db9d3c382432973ec689ef258cf280d6e44c1630a01c6ae356eeec0410378e67265b16724c77dfcb3e
+  metadata.gz: 0a95c043ea2fa4fa647bfdb05661772cfe4e2059054ad0fdd125e81916059f26e40c722c85c7c616428aa9a0c3d9902f03e400523feac815f0f3c3cd3b27690f
+  data.tar.gz: f0ffcc5fcb02f8655a262c6e32d41c8761e20a6faa91fdbd04bee407afd0f581b8423e302b196923449b450ce7d1957320e6c6774bf5323363b6da6bccbd3ce9

data/LICENSE.txt

@@ -1,20 +1,21 @@
+The MIT License (MIT)
+
 Copyright (c) 2015 Martin Jagusch
 
-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:
+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 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.
+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

@@ -1,18 +1,24 @@
 # Canyon
 
-Canyon is a Rails blogging engine, including only the backend. How you present the blog posts is up to you.
+Canyon is a Rails blogging engine, it is build to get included in another Rails application. Read more about how Rails engines work [here](http://guides.rubyonrails.org/engines.html). It includes the admin section to create and update blog posts and to manage authors. How you use and present the blog posts is up to your main Rails application.
+
+You can add Canyon to a new Rails application or an existing one.
 
 ### Installation
 
-Include the engine to your projects Gemfile. `Gemfile`
+Include the engine to your projects Gemfile.
+
+``` ruby
+# Gemfile
 
-```
 gem 'canyon'
 ```
 
-Include the routes from the engine to your applications routing file. `config/routes.rb`
+Include the routes from the engine to your applications routing file. What path you use for the admin section is up to you. In this example it is: `cy-admin`
 
 ``` ruby
+# config/routes.rb
+
 Rails.application.routes.draw do
   # All your application routes.
 
@@ -20,10 +26,34 @@ Rails.application.routes.draw do
 end
 ```
 
-Load the engine sample data. `db/seeds.rb` (optional)
+Load the engine sample data. (optional)
+
+``` ruby
+# db/seeds.rb
 
-```
 Canyon::Engine.load_seed
 ```
 
-Running `rake db:seed` will now include a default user and blog post.
+Running `rake db:seed` will now include a default user and blog post from the engines seed file.
+
+## Configure
+
+You can override any of the following defaults.
+
+``` ruby
+# config/initializers/canyon.rb
+
+Canyon.configure do |config|
+  config.display_summary_field = false
+  config.display_language_field = false
+end
+```
+
+## Usage
+
+To access published posts, use the following code in your e.g. controllers.
+
+``` ruby
+Canyon::Post.published
+# => ActiveRecord::Relation object to access published posts.
+```

data/app/views/canyon/posts/_form.html.erb

@@ -45,12 +45,14 @@
   </div>
 
   <div class="row">
-    <div class="col-md-6">
-      <div class="form-group">
-        <%= f.label :language %>
-        <%= f.select :language, Canyon::Post::LANGUAGES, {}, class: 'form-control' %>
+    <% if Canyon.configuration.display_language_field %>
+      <div class="col-md-6">
+        <div class="form-group">
+          <%= f.label :language %>
+          <%= f.select :language, Canyon::Post::LANGUAGES, {}, class: 'form-control' %>
+        </div>
       </div>
-    </div>
+    <% end %>
 
     <div class="col-md-6">
       <div class="form-group">
@@ -82,10 +84,12 @@
     </div>
   </div>
 
-  <div class="form-group">
-    <%= f.label :summary %>
-    <%= f.text_area :summary, rows: 3, class: 'form-control post-summary', placeholder: 'A short summary for the homepage.' %>
-  </div>
+  <% if Canyon.configuration.display_summary_field %>
+    <div class="form-group">
+      <%= f.label :summary %>
+      <%= f.text_area :summary, rows: 3, class: 'form-control post-summary', placeholder: 'A short summary for the homepage.' %>
+    </div>
+  <% end %>
 
   <div class="form-group">
     <%= f.label :content %>

data/app/views/layouts/canyon/application.html.erb

@@ -19,13 +19,12 @@
           <span class="icon-bar"></span>
           <span class="icon-bar"></span>
         </button>
+
         <%= link_to 'Canyon', posts_path, class: 'navbar-brand' %>
       </div>
       <div id="navbar" class="collapse navbar-collapse">
         <ul class="nav navbar-nav">
           <li class="active"><%= link_to 'Posts', posts_path %></li>
-          <li><%= link_to 'Categories', '#' %></li>
-          <li><%= link_to 'Authors', '#' %></li>
           <li>
             <%= link_to request.base_url, target: '_blank' do %>
               <%= request.base_url %>
@@ -38,12 +37,13 @@
   </nav>
 
   <div class="container">
-    <% flash.each do |name, flash_message| %>
+    <% flash.each do |name, message| %>
       <div class="alert alert-<%= name %> alert-dismissible" role="alert">
         <button type="button" class="close" data-dismiss="alert" aria-label="Close">
           <span aria-hidden="true">&times;</span>
         </button>
-        <p><%= raw flash_message %></p>
+
+        <p><%= raw message %></p>
       </div>
     <% end %>
 

data/db/migrate/20150416053508_create_authors.rb

@@ -2,7 +2,7 @@ class CreateAuthors < ActiveRecord::Migration
   def change
     create_table :canyon_authors do |t|
       t.string :name, null: false
-      t.string :slug, null: false
+      t.string :login, null: false
       t.timestamps null: false
     end
   end

data/db/migrate/20150416053518_create_posts.rb

@@ -2,10 +2,10 @@ class CreatePosts < ActiveRecord::Migration
   def change
     create_table :canyon_posts do |t|
       t.string :title, null: false
-      t.string :slug, null: false
-      t.string :language, null: false
+      t.string :slug
+      t.string :language
       t.text :summary
-      t.text :content, null: false
+      t.text :content
       t.integer :parent_id
       t.integer :author_id, null: false
       t.boolean :deleted, null: false, default: false

data/db/seeds.rb

@@ -1,15 +1,22 @@
-Canyon::Author.delete_all
-Canyon::Post.delete_all
-
-author = Canyon::Author.create(name: 'Guybrush Threepwood', slug: 'guybrush')
-Canyon::Author.create(name: 'Elaine Marley', slug: 'elaine')
+guybrush = Canyon::Author.create(name: 'Guybrush Threepwood', login: 'guybrush')
+elaine = Canyon::Author.create(name: 'Elaine Marley', login: 'elaine')
 
 Canyon::Post.create!(
-  author:   author,
+  author:   guybrush,
   language: 'en',
   title:    'Markdown Syntax Example',
   slug:     'markdown-syntax-example',
-  summary:  'This is our fist summary.',
-  content:  'This is our **fist posts**.',
-  published_at: Time.now,
+  summary:  'This is the fist summary.',
+  content:  'This is the **fist post**.',
+  published_at: 1.month.ago,
+)
+
+Canyon::Post.create!(
+  author:   elaine,
+  language: 'en',
+  title:    'Second Example',
+  slug:     'Second-example',
+  summary:  'This is the second summary.',
+  content:  'This is the **second post**.',
+  published_at: 1.day.ago,
 )

data/lib/canyon.rb

@@ -1,3 +1,4 @@
+require 'canyon/configuration'
 require 'canyon/engine'
 
 module Canyon

data/lib/canyon/configuration.rb

@@ -0,0 +1,18 @@
+module Canyon
+  class Configuration
+    attr_accessor :display_summary_field, :display_language_field
+
+    def initialize
+      @display_summary_field = false
+      @display_language_field = false
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

data/lib/canyon/version.rb

@@ -1,3 +1,3 @@
 module Canyon
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: canyon
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Martin Jagusch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-01 00:00:00.000000000 Z
+date: 2015-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -109,6 +109,7 @@ files:
 - db/migrate/20150416053518_create_posts.rb
 - db/seeds.rb
 - lib/canyon.rb
+- lib/canyon/configuration.rb
 - lib/canyon/engine.rb
 - lib/canyon/version.rb
 - lib/tasks/canyon_tasks.rake