changeful 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa995530b08a1b27bae9dde22b5b2fc9b30a9078
+  data.tar.gz: 898b7a74ab585b3a2b5436e69c0f2b77b7fb7925
+SHA512:
+  metadata.gz: 84c648d6662c2f964a1721c9dd2d0ca4a9d34532b59d76e3cc2887724e844e703c787d35d22b99c44bac2ab41700a505ad8527ae689506ae581fd105c1cea41d
+  data.tar.gz: 568cd1deb6c9253a5f708b477b9ec932f2849ceec02264cc263a1adae9b79d218920e9fc936d1c138526281a226f1fac5f34ae06827bcc552a0282941a4497d4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/tmp/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+changeful

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in changeful.gemspec
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Wayne Tng
+
+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 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

@@ -0,0 +1,169 @@
+# 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)
+[![Test Coverage](https://codeclimate.com/github/futureworkz/changeful/badges/coverage.svg)](https://codeclimate.com/github/futureworkz/changeful/coverage)
+[![Inline docs](http://inch-ci.org/github/futureworkz/changeful.svg)](http://inch-ci.org/github/futureworkz/changeful)
+[![security](https://hakiri.io/github/futureworkz/changeful/master.svg)](https://hakiri.io/github/futureworkz/changeful/master)
+
+Do you need to allow your administrator to edit the static content of your views?
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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
+```
+
+This will generate the migration needed for Changeful
+
+Run the migration to update the schema
+
+```ruby
+rake db:migrate
+```
+
+## Usage
+
+### ERB
+```ruby
+<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>
+    <div class='more-content'>Nested tags are also okay.</div>
+  <% end %>
+</div>
+```
+
+### HAML
+```ruby
+%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.
+    .more-content Nested tags are also okay.
+```
+
+### Slim
+```ruby
+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.
+    .more-content Nested tags are also okay.
+```
+
+The view helper method `changeful_content` will return the content found in Changeful database. You can also set a default if there is no content found.
+
+## Available Options
+
+Key | Accepted Values | What it does
+---|---|--- 
+`default` | String | It sets the default content to return if the key is not found in database
+`type` | `:plain`, `:html` | It tells backend gems to display the correct input field in the backend
+
+## More Examples
+
+```ruby
+# In your views
+changeful_content(:about_us_title)
+changeful_content(:about_us_title, default: 'About Us')
+changeful_content(:about_us_title, default: 'About Us', type: :plain) 
+
+# Or you can use the shorter method alias cc
+cc :about_us_title
+cc :about_us_title, default: 'About Us'
+cc :about_us_title, default: 'About Us', type: :plain
+```
+
+## Integration with back-end
+
+### ActiveAdmin
+Currently it only work well with ActiveAdmin
+
+Register the model with ActiveAdmin
+
+```ruby
+rails g active_admin:resource Changeful::Content
+``` 
+
+By default it will create `changeful_content.rb` in `app/admin` folder
+
+#### Configuration for ActiveAdmin
+
+Copy the setup below to `changeful_content.rb`
+
+Note: the example below is using `ckeditor` gem, replace the editor 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
+
+  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
+```
+## Contributing
+
+1. Fork it ( https://github.com/futureworkz/changeful/fork   )
+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. Create a new Pull Request
+
+## 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.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "changeful"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/changeful.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'changeful/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "changeful"
+  spec.version       = Changeful::VERSION
+  spec.authors       = ["Wayne Tng"]
+  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.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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"
+end

data/lib/changeful.rb

@@ -0,0 +1,12 @@
+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
+end
+
+module Changeful # :nodoc:
+  # Your code goes here...
+end

data/lib/changeful/helpers/view_helpers.rb

@@ -0,0 +1,55 @@
+require_relative '../models/changeful_content'
+require 'action_view/helpers/output_safety_helper'
+require 'action_view/helpers/capture_helper'
+
+module Changeful
+  # The Changeful ViewHelpers expose the methods to be used in view 
+  # to make the static content editable
+  module ViewHelpers
+    include ActionView::Helpers::CaptureHelper
+    include ActionView::Helpers::OutputSafetyHelper
+    # Returns a content based on a key and store in the database if it does not exist
+    #
+    # @example
+    #   changeful_content(:about_us_title) 
+    #   changeful_content(:about_us_title, default: 'About Us')
+    #   changeful_content(:about_us_title, default: 'About Us', type: :plain) 
+    #
+    #   cc :about_us_title
+    #   cc :about_us_title, default: 'About Us'
+    #   cc :about_us_title, default: 'About Us', type: :plain
+    #
+    # @param key [Symbol] A unique key in the view file to be referenced
+    # @param options [Hash] Additional configuration options (refer below)
+    # @option options [Symbol] :default It sets the default content to return if the key is not found in database
+    # @option options [Symbol] :type Specify the type of input to be displayed in the backend. Accepted types are :plain, :html
+    # 
+    # @return [String] a content based on a key
+    def changeful_content(key, options = {})
+      contents ||= Content.all_contents_in(current_view)
+
+      if contents.present?
+        contents.each do |datum|
+          return raw(datum.content) if datum.key == key.to_s
+        end
+      end
+
+      content   = options.delete(:default) || capture(&proc)
+      view_type = options.delete(:type)    || :plain
+      Content.create!(key: key, 
+                      content: content, 
+                      view_type: view_type, 
+                      file_path: current_view)
+
+      return content
+    end
+
+    alias_method :cc, :changeful_content
+
+    private
+
+    def current_view
+      File.basename(File.dirname(__FILE__)) + '/' + File.basename(__FILE__, '.*')
+    end
+  end
+end

data/lib/changeful/models/changeful_content.rb

@@ -0,0 +1,12 @@
+require 'active_record'
+
+module Changeful
+  class Content < ActiveRecord::Base
+    self.table_name = :changeful_contents
+
+    validates :key, :content, :view_type, :file_path, presence: true
+    validates :key, uniqueness: { scope: :file_path }
+
+    scope :all_contents_in, ->(current_view) { where('file_path = ?', current_view) }
+  end
+end

data/lib/changeful/version.rb

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

data/lib/generators/changeful/install_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators/base'
+require 'rails/generators/active_record'
+
+module Changeful
+  module Generators
+    class InstallGenerator < Rails::Generators::Base # :nodoc:
+      include Rails::Generators::Migration
+
+      def copy_changeful_migration
+        migration_template 'migration.rb',
+                           'db/migrate/create_changeful_contents.rb'
+      end
+
+      def self.source_root
+        File.dirname(__FILE__) + '/templates'
+      end
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+class CreateChangefulContents < ActiveRecord::Migration # :nodoc:
+  def change
+    create_table :changeful_contents do |t|
+      t.string :key
+      t.text :content
+      t.string :view_type
+      t.string :file_path
+      t.timestamps null: true
+    end
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: changeful
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wayne Tng
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 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.
+email:
+- wayne@futureworkz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- changeful.gemspec
+- lib/changeful.rb
+- lib/changeful/helpers/view_helpers.rb
+- lib/changeful/models/changeful_content.rb
+- lib/changeful/version.rb
+- lib/generators/changeful/install_generator.rb
+- lib/generators/changeful/templates/migration.rb
+homepage: https://github.com/futureworkz/changeful
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Make your static contents editable in database
+test_files: []