effective_posts 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 896d5d35da11a85728025e30637b1b98b0d8444c
-  data.tar.gz: f1be7c5c2bdab2b86fdcbb80bb424fe3b0b404c4
+  metadata.gz: eca3438b280dc68df0a2068bc09754ebdf9d11f5
+  data.tar.gz: e84fcb3c11970fe9f60f3917c4bbcf97cd39ce5f
 SHA512:
-  metadata.gz: d581efa632c5220c944c326493bc392ef9c0e91f259dfe8fbf6652f181642ce5fba3c1b7d513393b32b2a81beb6d1378384d3d7060549f20bd96046ba51a2b6b
-  data.tar.gz: 6d24be4f730f39c57802747a85d5c79dc961dba908c37b050dd53d90742114dae54875c44ec52315f24fecfa86ab478079706443bd9ae1783b9fd0bdbdbb9fb1
+  metadata.gz: 8e8f78680d751d43fd2cc15b7daff3150075601522d6f330fc3b2ce18132a560c3704e915d5e176540aa38008f4eed95e9344298db47715255e62dbd66b1a21d
+  data.tar.gz: f572bc531f7f88a3a093b97d3f543db5bb8b00c7db8f35eeaa9ed0b0cbbcf700c9499cb87af8b96d69dd1a6e0f8bfc073a7e0c8a332b17edd4ac3578da14c4d3

data/README.md

@@ -1,7 +1,175 @@
 # Effective Posts
 
-WIP Gem
+A blog implementation with WYSIWYG content editing, post scheduling, pagination and optional top level routes for each post category.
 
-## TODO
+Built ontop of effective_regions for post content entry and Kaminari for pagination.
 
-Write a README
+Rails 3.2.x and 4.x
+
+
+## Getting Started
+
+Please first install the [effective_regions](https://github.com/code-and-effect/effective_regions) and [effective_datatables](https://github.com/code-and-effect/effective_datatables) gems.
+
+Please download and install [Twitter Bootstrap3](http://getbootstrap.com)
+
+Add to your Gemfile:
+
+```ruby
+gem 'effective_posts'
+```
+
+Run the bundle command to install it:
+
+```console
+bundle install
+```
+
+Then run the generator:
+
+```ruby
+rails generate effective_posts:install
+```
+
+The generator will install an initializer which describes all configuration options and creates a database migration.
+
+If you want to tweak the table name (to use something other than the default 'posts'), manually adjust both the configuration file and the migration now.
+
+Then migrate the database:
+
+```ruby
+rake db:migrate
+```
+
+There are no required javascript or stylesheet includes.
+
+
+## Posts
+
+To create your first post, visit `/admin/posts` and click `New Post`.
+
+If you've defined more than one category in the `/app/config/initializers/effective_posts.rb` initializer, you will be asked to assign this post a category.  Otherwise the default category `posts` will be assigned.
+
+You can schedule a post to appear at a later date by setting the published_at value to a future date.
+
+If you're using the [effective_form_inputs](https://github.com/code-and-effect/effective_form_inputs) gem, the published_at input will be displayed with a nice bootstrap3 datetimepicker, otherwise it will use the default simple_form datetime input (which is pretty bad).
+
+As well, if you're using the [effective_roles](https://github.com/code-and-effect/effective_roles) gem, you will be able to configure permissions so that only permitted users may view this post.
+
+Once you click `Save and Edit Content` you will be brought into the effective_regions editor where you may enter the content for your post.  Click `Insert Snippet` -> `Read more divider` from the toolbar to place a divider into your post.  Only the content above the Read more divider, the excerpt content, will be displayed on any posts#index screens.  The full content will be displayed on the posts#show screen.
+
+
+## Category Routes
+
+If `config.use_category_routes` is enabled in the `/app/config/initializers/effective_posts.rb` initializer, each category you specify will automatically have a top level route.  So posts created in the `:blog` category will be available at `/blog` and any posts made in that category will be available at `/blog/1-my-post-title`.
+
+If disabled, all posts will be available at `/posts`, with posts for a specific category available at `/posts?category=blog` and the show routes will be `/posts/1-my-post-title` regardless of category.
+
+
+## Helpers
+
+Use `link_to_post_category(:blog)` to display a link to the Blog page.  The helper considers `config.use_category_routes` and puts in the correct url.
+
+
+## Pagination
+
+The [kaminari](https://github.com/amatsuda/kaminari) gem is used for pagination on all posts#index type screens.
+
+The per_page for posts may be configured via the `/app/config/initializers/effective_posts.rb` initializer.
+
+Included within this gem is the bootstrap3 theme for kaminari, but, as with any gem, your app-specific kaminari views will take priority over these included views.
+
+
+
+## Authorization
+
+All authorization checks are handled via the config.authorization_method found in the `app/config/initializers/effective_posts.rb` file.
+
+It is intended for flow through to CanCan or Pundit, but neither of those gems are required.
+
+This method is called by all controller actions with the appropriate action and resource
+
+Action will be one of [:index, :show, :new, :create, :edit, :update, :destroy]
+
+Resource will the appropriate Effective::Post object or class
+
+The authorization method is defined in the initializer file:
+
+```ruby
+# As a Proc (with CanCan)
+config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) }
+```
+
+```ruby
+# As a Custom Method
+config.authorization_method = :my_authorization_method
+```
+
+and then in your application_controller.rb:
+
+```ruby
+def my_authorization_method(action, resource)
+  current_user.is?(:admin) || EffectivePunditPolicy.new(current_user, resource).send('#{action}?')
+end
+```
+
+or disabled entirely:
+
+```ruby
+config.authorization_method = false
+```
+
+If the method or proc returns false (user is not authorized) an Effective::AccessDenied exception will be raised
+
+You can rescue from this exception by adding the following to your application_controller.rb:
+
+```ruby
+rescue_from Effective::AccessDenied do |exception|
+  respond_to do |format|
+    format.html { render 'static_pages/access_denied', :status => 403 }
+    format.any { render :text => 'Access Denied', :status => 403 }
+  end
+end
+```
+
+### Permissions
+
+The permissions you actually want to define are as follows (using CanCan):
+
+```ruby
+can [:index, :show], Effective::Post
+can [:manage], Effective::Post if user.is?(:admin)
+```
+
+## Future Plans
+
+There are some obvious additional features that have yet to be implemented:
+
+- Tagging
+- Some kind of helper for displaying a sidebar for the categories
+- Post archives and date filtering
+
+
+## License
+
+MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)
+
+Code and Effect is the product arm of [AgileStyle](http://www.agilestyle.com/), an Edmonton-based shop that specializes in building custom web applications with Ruby on Rails.
+
+
+## Testing
+
+Run tests by:
+
+```ruby
+guard
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Bonus points for test coverage
+6. Create new Pull Request

data/config/routes.rb

@@ -8,6 +8,8 @@ EffectivePosts::Engine.routes.draw do
 
     if EffectivePosts.use_category_routes
       EffectivePosts.categories.each do |category|
+        next if category.to_s == 'posts'
+
         match "#{category}", :to => 'posts#index', :via => [:get], :defaults => {:category => category.to_s }
         match "#{category}/:id", :to => 'posts#show', :via => [:get], :defaults => {:category => category.to_s }
       end

data/lib/effective_posts/version.rb

@@ -1,3 +1,3 @@
 module EffectivePosts
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/generators/templates/effective_posts.rb

@@ -3,9 +3,8 @@
 EffectivePosts.setup do |config|
   config.posts_table_name = :posts
 
-  # Every post must belong to one or more category
-  # Only add to the end of this array.  Never prepend categories.
-  # Don't include :posts
+  # Every post must belong to one or more category.
+  # Don't use the category :posts
   config.categories = [:blog, :news]
 
   # Create top level routes for each category

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_posts
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-28 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -122,7 +122,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.2
-description: CRUD Posts with intention to work with EffectiveRegions. WIP.
+description: A blog implementation with WYSIWYG content editing, post scheduling,
+  pagination and optional top level routes for each post category.
 email:
 - info@codeandeffect.com
 executables: []
@@ -194,7 +195,8 @@ rubyforge_project:
 rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
-summary: CRUD Posts with intention to work with EffectiveRegions. WIP.
+summary: A blog implementation with WYSIWYG content editing, post scheduling, pagination
+  and optional top level routes for each post category.
 test_files:
 - spec/effective_pages_spec.rb
 - spec/spec_helper.rb