static_content 1.1.1 → 1.2.0

data/README.md

@@ -0,0 +1,118 @@
+# Static Content
+[![RubyGems][gem_version_badge]][ruby_gems]
+[![Travis CI][travis_ci_badge]][travis_ci]
+[![Coveralls][coveralls_badge]][coveralls]
+[![Code Climate][code_climate_badge]][code_climate]
+[![Gemnasium][gemnasium_badge]][gemnasium]
+
+Static Content provides an easy way of defining static content in your application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'static_content'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install static_content
+
+After install the gem, you just need run the install generator:
+
+    $ rails g static_content:install
+
+## Usage
+
+### Creating content
+
+The content we create can be normal text or a markdown. Let`s see the way we can create a content.
+
+#### Standard Way
+
+You can create as a normal model with:
+
+    Content.create({slug: :about_title, text: "My awesome about page"}, as: :admin)
+
+special attention to the `as: :admin`, the fields is only acessible to `admin`.
+
+This is intended to be used with admin panels such as Typus or ActiveAdmin.
+
+#### The better way
+
+The better way is to use the `Content.from_slug` like:
+
+    Content.from_slug(:about_title, default: "My awesome about page")
+
+as this uses `find_or_initialize`, if is a new `slug` its create, if a old one its only return the value not raising a error.
+
+So you can use this on a seed for example to create the default things.
+
+### Showing content
+
+#### content
+
+Show your content as html converted from markdown, in your view, just add:
+
+```
+<%= c :about_title, default: "# My awesome about page" %>
+```
+
+to be converted into
+
+```
+<h1>My awesome about page</h1>
+```
+
+Please note that a `default` option is required. If it hasn't been created, it will be created upon the first request.
+
+#### raw content
+
+Show your raw content, in your view, just add:
+
+```
+<%= rc :about_title, default: "# My awesome about page" %>
+```
+
+no change the value as
+
+```
+# My awesome about page
+```
+
+Please note that a `default` option is required. If it hasn't been created, it will be created upon the first request.
+
+## Warning
+
+Static Content generates a model [`Content`](https://github.com/Helabs/static_content/blob/master/app/models/content.rb) and a table [`contents`](https://github.com/Helabs/static_content/blob/master/db/migrate/20120705141451_create_contents.rb), so your app should not contain this model and table.
+
+## Versioning
+
+Static Content follow the [Semantic Versioning](http://semver.org/).
+
+## Issues
+
+If you have problems, please create a [Github Issue](https://github.com/Helabs/static_content/issues).
+
+## Contributing
+
+Please see [CONTRIBUTING.md](https://github.com/Helabs/static_content/blob/master/CONTRIBUTING.md) for details.
+
+## Credits
+
+Static Content is maintained and funded by [HE:labs](http://helabs.com.br/opensource/).
+Thank you to all the [contributors](https://github.com/Helabs/static_content/graphs/contributors).
+
+[gem_version_badge]: https://badge.fury.io/rb/static_content.png
+[ruby_gems]: http://rubygems.org/gems/static_content
+[code_climate]: https://codeclimate.com/github/Helabs/static_content
+[code_climate_badge]: https://codeclimate.com/github/Helabs/static_content.png
+[travis_ci]: http://travis-ci.org/Helabs/static_content
+[travis_ci_badge]: https://secure.travis-ci.org/Helabs/static_content.png
+[gemnasium]: https://gemnasium.com/Helabs/static_content
+[gemnasium_badge]: https://gemnasium.com/Helabs/static_content.png
+[coveralls]: https://coveralls.io/r/Helabs/static_content
+[coveralls_badge]: https://coveralls.io/repos/Helabs/static_content/badge.png?branch=master

data/app/helpers/content_helper.rb

@@ -1,4 +1,5 @@
 module ContentHelper
+
   def content(*args)
     Content.from_slug(*args).parsed_text
   end

data/app/models/content.rb

@@ -1,8 +1,21 @@
 require 'rdiscount' #TODO: Fix this stupid require statement.
 class Content < ActiveRecord::Base
+
   attr_accessible :slug, :text, as: :admin
+
   validates :slug, :text, presence: true
-  validates_uniqueness_of :slug
+  validates :slug, uniqueness: true
+
+  def self.from_slug(slug, options={})
+    raise ArgumentError.new("You must provide a default text for a content.") if options[:default].nil?
+    find_or_initialize_by_slug(slug).tap do |content|
+      if content.new_record?
+        content.name = slug
+        content.text = options[:default]
+        content.save
+      end
+    end
+  end
 
   def parsed_text
     markdown.to_html.html_safe
@@ -12,27 +25,10 @@ class Content < ActiveRecord::Base
     text.html_safe
   end
 
-  def markdown
-    @content ||= RDiscount.new(text)
-  end
-
-
+  private
 
-  class << self
-    def from_slug(slug, options={})
-      raise NoDefaultContentError if options[:default].nil?
-      find_or_initialize_by_slug(slug).tap do |content|
-        if content.new_record?
-          content.name = slug
-          content.text = options[:default]
-          content.save
-        end
-      end
+    def markdown
+      @content ||= RDiscount.new(text)
     end
-  end
-end
-class NoDefaultContentError < StandardError
-  def initialize(msg = "You must provide a default text for a content.")
-    super(msg)
-  end
 end
+

data/lib/static_content/version.rb

@@ -1,3 +1,3 @@
 module StaticContent
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: static_content
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
 - Pedro Nascimento
 - Sylvestre Mergulhao
 - Rodrigo Pinto
+- Mauro George
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-23 00:00:00.000000000 Z
+date: 2013-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,7 +37,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: 2.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,7 +45,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.6.8
+        version: 2.1.6
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -61,6 +62,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +145,7 @@ files:
 - lib/tasks/static_content_tasks.rake
 - MIT-LICENSE
 - Rakefile
-- README.mkdn
+- README.md
 homepage: https://github.com/Helabs/static_content
 licenses: []
 post_install_message: 
@@ -143,7 +160,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2033020220625899342
+      hash: 2073422727724312165
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -152,10 +169,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2033020220625899342
+      hash: 2073422727724312165
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: static_content provides a simple way of outputting static content in your

data/README.mkdn

@@ -1,37 +0,0 @@
-### work in progress.
-
-#What is static_content?
-static_content provides an easy way of defining static content in your application.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'static_content'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install static_content
-
-After install the gem, you just need run the install generator:
-
-    $ rails g static_content:install
-
-#Usage
-
-In your view, just add:
-
-```erb
-<%=c :sidebar_content, default: "Placeholder Sidebar Content" %>
-```
-
-Please note that a `default` option is required. If it hasn't been created, it will be created upon the first request.
-
-This is intended to be used with admin panels such as Typus or ActiveAdmin.
-
-
-This project rocks and uses MIT-LICENSE.