changeful 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa995530b08a1b27bae9dde22b5b2fc9b30a9078
-  data.tar.gz: 898b7a74ab585b3a2b5436e69c0f2b77b7fb7925
+  metadata.gz: 82dad8cdeb433e1a3211c81eea7ff0a61bb82fa6
+  data.tar.gz: 489504cc58fbf58bbcf9dde4fd0bb7aa3efdf45e
 SHA512:
-  metadata.gz: 84c648d6662c2f964a1721c9dd2d0ca4a9d34532b59d76e3cc2887724e844e703c787d35d22b99c44bac2ab41700a505ad8527ae689506ae581fd105c1cea41d
-  data.tar.gz: 568cd1deb6c9253a5f708b477b9ec932f2849ceec02264cc263a1adae9b79d218920e9fc936d1c138526281a226f1fac5f34ae06827bcc552a0282941a4497d4
+  metadata.gz: f2c2f7810a5c4e0591efee8d30e36b830b2f736c84d264214b0ec7aed89a15a00b6e2992e9a16c121c8281e5cacc7e602b8636e3cef883865602e0782963fb8c
+  data.tar.gz: c76ceec2047a4f2e3aecae0bc673b2fce543bd3ade3faff7d170ab150d28dc03e17a1e303c8ffe5aa4fcdbc269d97d18b8255117e33e8a42ea5953fffe76cf3b

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.2.0 (16-09-15)
+- Added:
+  - Support Rails Admin with built-in generator.
+  - Required ruby version to be 2.0.0.
+
+- Refactor
+  - Convert ActiveAdmin into a generator for easy access to default configuration.

data/Gemfile

@@ -3,3 +3,5 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in changeful.gemspec
 
 gemspec
+
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -1,5 +1,5 @@
 # Changeful
-
+[![Gem Version](https://badge.fury.io/rb/changeful.svg)](http://badge.fury.io/rb/changeful)
 [![Build Status](https://travis-ci.org/futureworkz/changeful.svg?branch=master)](https://travis-ci.org/futureworkz/changeful)
 [![Dependency Status](https://gemnasium.com/futureworkz/changeful.svg)](https://gemnasium.com/futureworkz/changeful)
 [![Code Climate](https://codeclimate.com/github/futureworkz/changeful/badges/gpa.svg)](https://codeclimate.com/github/futureworkz/changeful)
@@ -21,36 +21,35 @@ gem 'changeful'
 
 And then execute:
 
-```ruby
+```
 $ bundle install
 ```
 
 Or install it yourself as:
 
-```ruby
+```
 $ gem install changeful
 ```
 
 After you install Changeful to your Gemfile, you need to run the generator:
 
-```ruby
-rails generate changeful:install
+```
+$ rails generate changeful:install
 ```
 
 This will generate the migration needed for Changeful
 
 Run the migration to update the schema
 
-```ruby
-rake db:migrate
+```
+$ rake db:migrate
 ```
 
 ## Usage
 
 ### ERB
-```ruby
+```erb
 <h1><%= changeful_content(:about_us_title) %></h1>
-
 <div class='about-us-content'>
   <%= changeful_content :about_us_content do %>
     <p>You can also include HTML content as the default content in a block.</p>
@@ -60,7 +59,7 @@ rake db:migrate
 ```
 
 ### HAML
-```ruby
+```haml
 %h1= changeful_content(:about_us_title)
 .about-us-content
   = changeful_content :about_us_content do
@@ -69,9 +68,8 @@ rake db:migrate
 ```
 
 ### Slim
-```ruby
+```slim
 h1 = changeful_content(:about_us_title)
-
 .about-us-content
   = changeful_content :about_us_content do
     p You can also include HTML content as the default content in a block.
@@ -104,59 +102,71 @@ cc :about_us_title, default: 'About Us', type: :plain
 ## Integration with back-end
 
 ### ActiveAdmin
-Currently it only work well with ActiveAdmin
+Run the following CLI to generate the model
+
+```
+$ rails generate changeful:models:active_admin
+``` 
+
+By default it will create `changeful_content.rb` in `app/admin` folder with the default configuration.
+
+Note: The default configuration for text editor assumes you are using the `ckeditor` gem, replace the editor accordingly.
 
-Register the model with ActiveAdmin
+
+### Rails Admin
+There are two approaches to set up rails admin.
+
+To include the ALL models manually.
 
 ```ruby
-rails g active_admin:resource Changeful::Content
-``` 
+# config/initializers/rails_admin.rb
+
+config.included_models = ["Changeful::Content", "YourOwnModel", "YourAnotherModel" ]
+```
 
-By default it will create `changeful_content.rb` in `app/admin` folder
+OR you can run the following CLI to generate the model.
 
-#### Configuration for ActiveAdmin
+```
+$ rails generate changeful:models:rails_admin
+```
+
+This will generate `changeful_content.rb` in `app/model` with the default configuration for rails admin.
 
-Copy the setup below to `changeful_content.rb`
+Note: The default configuration for text editor assumes you are using the `ckeditor` gem, replace the editor accordingly.
 
-Note: the example below is using `ckeditor` gem, replace the editor accordingly.
+In the case where default configuration is not needed, run the following CLI.
+
+```
+$ rails generate changeful:model
+```
+
+This will generate a fresh `changeful_content.rb` in `app/model`
+
+#### Additional Configuration for Rails Admin
+You may wish to deactivate `create` to prevent users from creating records in changeful content.
+
+`destroy` is optional, if the admin delete the record, the `default` option will be trigger and re-create the content accordingly.
 
 ```ruby
-ActiveAdmin.register Changeful::Content do
-  permit_params :content
-  actions :all, except: [:new]
-
-  index do
-    selectable_column
-    id_column
-    column :key, ->(row) { row.key.titleize  }
-    column :content
-    column :updated_at
-    actions
-  end
+# config/initializers/rails_admin.rb
 
-  show do
-    attributes_table do
-      row :id
-      row :file_path
-      row :key
-      row :content
-      row :updated_at
-    end
+config.actions do
+  dashboard                     # mandatory
+  index                         # mandatory
+  new do
+    except ['ChangefulContent']
   end
-
-  form do |f|
-    f.inputs 'Details' do
-      input :key, input_html: { disabled: true  }
-      if f.object.view_type == 'html'
-        input :content, as: :ckeditor
-      else
-        input :content
-      end
-    end
-    actions
+  export
+  bulk_delete
+  show
+  edit
+  delete do
+    except ['ChangefulContent']
   end
+  show_in_app
 end
 ```
+
 ## Contributing
 
 1. Fork it ( https://github.com/futureworkz/changeful/fork   )
@@ -167,3 +177,8 @@ end
 
 ## License
 Changeful is Copyright © 2015 Futureworkz Pte Ltd. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+
+## About Futureworkz
+<a href='http://www.futureworkz.com' title='Futureworkz - Ruby on Rails development' target='_blank'><img src='https://s3-ap-southeast-1.amazonaws.com/futureworkz/3rd-party/logo.png' alt='Futureworkz - Ruby on Rails development'/></a>
+
+Changeful is maintained by <a href='http://www.futureworkz.com' title='Futureworkz - Ruby on Rails development' target='_blank'> Futureworkz </a>.

data/changeful.gemspec

@@ -4,26 +4,27 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'changeful/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "changeful"
+  spec.name          = 'changeful'
   spec.version       = Changeful::VERSION
-  spec.authors       = ["Wayne Tng"]
-  spec.email         = ["wayne@futureworkz.com"]
+  spec.authors       = ['Wayne Tng', 'Steven Yap']
+  spec.email         = ['wayne@futureworkz.com']
 
   spec.summary       = %q{Make your static contents editable in database}
   spec.description   = %q{Changeful is a gem that converts your static content in your views to be stored into database. Thereafter, administrator can use RailsAdmin or Active Admin to edit the static content.}
-  spec.homepage      = "https://github.com/futureworkz/changeful"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/futureworkz/changeful'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_dependency "rails", "> 4.2.0"
+  spec.add_dependency 'rails', '> 4.2.0'
 
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "rspec-rails"
-  spec.add_development_dependency "generator_spec"
-  spec.add_development_dependency "shoulda-matchers"
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'generator_spec'
+  spec.add_development_dependency 'shoulda-matchers'
 end

data/lib/changeful.rb

@@ -1,12 +1,11 @@
-require "changeful/version"
-require "changeful/models/changeful_content"
-require "changeful/helpers/view_helpers"
-require "active_support/lazy_load_hooks"
+require 'changeful/version'
+require 'changeful/models/changeful_content'
+require 'changeful/helpers/view_helpers'
+require 'active_support/lazy_load_hooks'
 
 ActiveSupport.on_load(:action_view) do
-    include Changeful::ViewHelpers
+  include Changeful::ViewHelpers
 end
 
 module Changeful # :nodoc:
-  # Your code goes here...
 end

data/lib/changeful/version.rb

@@ -1,3 +1,3 @@
 module Changeful
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/lib/generators/changeful/model_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/base'
+
+module Changeful
+  module Generators
+    class ModelGenerator < Rails::Generators::Base # :nodoc:
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_changeful_model_file
+        copy_file 'model.rb', 'app/models/changeful_content.rb'
+      end
+    end
+  end
+end

data/lib/generators/changeful/models/active_admin_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/base'
+
+module Changeful
+  module Generators
+    module Models
+      class ActiveAdminGenerator < Rails::Generators::Base # :nodoc:
+        source_root File.expand_path('../../templates', __FILE__)
+
+        def copy_changeful_active_admin_model_file
+          copy_file 'active_admin.rb', 'app/admin/changeful_content.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/changeful/models/rails_admin_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators/base'
+
+module Changeful
+  module Generators
+    module Models
+      class RailsAdminGenerator < Rails::Generators::Base # :nodoc:
+        source_root File.expand_path('../../templates', __FILE__)
+
+        def copy_changeful_rails_admin_model_file
+          copy_file 'rails_admin.rb', 'app/models/changeful_content.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/changeful/templates/active_admin.rb

@@ -0,0 +1,35 @@
+ActiveAdmin.register Changeful::Content, as: 'Contents' do
+  permit_params :content
+  actions :all, except: [:new, :destroy]
+
+  index do
+    selectable_column
+    id_column
+    column :key, ->(row) { row.key.titleize  }
+    column :content
+    column :updated_at
+    actions
+  end
+
+  show do
+    attributes_table do
+      row :id
+      row :file_path
+      row :key
+      row :content
+      row :updated_at
+    end
+  end
+
+  form do |f|
+    f.inputs 'Details' do
+      input :key, input_html: { disabled: true  }
+      if f.object.view_type == 'html'
+        input :content, as: :ckeditor
+      else
+        input :content
+      end
+    end
+    actions
+  end
+end

data/lib/generators/changeful/templates/migration.rb

@@ -1,4 +1,4 @@
-class CreateChangefulContents < ActiveRecord::Migration # :nodoc:
+class CreateChangefulContents < ActiveRecord::Migration
   def change
     create_table :changeful_contents do |t|
       t.string :key

data/lib/generators/changeful/templates/model.rb

@@ -0,0 +1,3 @@
+class ChangefulContent < ActiveRecord::Base
+
+end

data/lib/generators/changeful/templates/rails_admin.rb

@@ -0,0 +1,41 @@
+class ChangefulContent < ActiveRecord::Base
+  rails_admin do
+    label 'Content'
+    label_plural 'Contents'
+    list do
+      field :id
+      field :key
+      field :content
+      field :file_path
+      field :updated_at do
+        strftime_format "%d-%m-%y"
+      end
+    end
+
+    show do
+      field :id
+      field :key
+      field :content
+      field :file_path
+      field :updated_at do
+        strftime_format "%d-%m-%y"
+      end
+    end
+
+    edit do
+      field :id do
+        read_only true
+        help false
+      end
+      field :key do
+        read_only true
+        help false
+      end
+      field :content, :ck_editor
+      field :file_path do
+        read_only true
+        help false
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: changeful
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wayne Tng
+- Steven Yap
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2015-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +109,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -121,7 +123,13 @@ files:
 - lib/changeful/models/changeful_content.rb
 - lib/changeful/version.rb
 - lib/generators/changeful/install_generator.rb
+- lib/generators/changeful/model_generator.rb
+- lib/generators/changeful/models/active_admin_generator.rb
+- lib/generators/changeful/models/rails_admin_generator.rb
+- lib/generators/changeful/templates/active_admin.rb
 - lib/generators/changeful/templates/migration.rb
+- lib/generators/changeful/templates/model.rb
+- lib/generators/changeful/templates/rails_admin.rb
 homepage: https://github.com/futureworkz/changeful
 licenses:
 - MIT
@@ -134,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="