feather_cms 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in feather_cms.gemspec
+gemspec

data/README.md

@@ -0,0 +1,46 @@
+# Motivation
+ We have felt the pain of integrating static pages into a Rails application. There are plenty of gems available for this (Radiant, Locomotiv, etc.) but they are very heavy for what we need.
+
+So, we built FeatherCMS. As the name suggests, its a Do-It-Yourself, lightweight CMS - just pages, caching and nothing more!
+
+# Usage
+Add the gem to your Gemfile
+
+    gem 'feather_cms'
+
+Now, generate the pages 
+
+    $ rake db:migrate
+
+    $ rails g feather_cms about_us jobs team
+
+This generates a route, the controller action and the view for each page. Start the server and use the URL http://localhost:3000/feathers/pages to go to the admin panel. 
+
+This has basic HTTP authentication setup.The default username and password are feather/password and you can change this in feathers_controller.rb
+
+      http_basic_authenticate_with name: 'feather', password: 'password', except: :published
+
+# Features
+
+* Creates a route for each static page.
+* Caching the static pages.
+* Creates the view in app/views/feathers folder
+* Easily customization FeathersController
+* CodeMirror Editor for syntax highlighting. (Default: HTML)
+* Storage is file (default) or database.
+
+# Caveats
+You may need to ensure that the public/system folder exists (for file storage)
+
+# TODO
+
+* Move the basic authentication to the config/initializers/feather_cms.rb
+* Override the default authentication strategy from the controller
+* Move the code from generated controller to the gem (if required)
+    
+# Contribute
+Fork away and send me pull requests!
+
+# License 
+The MIT license
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/feather_cms.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "feather_cms/version"
+
+Gem::Specification.new do |s|
+  s.name        = "feather_cms"
+  s.version     = FeatherCms::VERSION
+  s.authors     = ["Jiren Patel"]
+  s.email       = ["jiren@joshsoftware.com"]
+  s.homepage    = ""
+  s.summary     = %q{Lightweight do it youself cms}
+  s.description = %q{Lightweight do it youself cms}
+
+  s.rubyforge_project = "feather_cms"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/feather_cms/config.rb

@@ -0,0 +1,54 @@
+module FeatherCms
+  class Config
+    class << self
+      attr_accessor :cache_max_limit, :cache_permanent_keys
+      attr_accessor :template_store_type
+
+      @@config = {
+        :template_store_path => 'templates',
+        :use_version => true,
+        :template_extenstion => 'html'
+      }
+
+      def init(&block)
+        yield self if block_given? 
+
+        template_store_type = (template_store_type || :file).to_sym
+        FeatherCms::TemplateCache.init
+        Dir.mkdir(template_store_path) unless Dir.exists?(template_store_path)
+
+        if defined?(ActionView::Helpers)
+          ActionView::Helpers.send(:include, FeatherCms::ViewHelper)
+        end
+
+        if defined?(Rails)
+          @@config[:layouts] = Dir.entries(Rails.root.to_s + '/app/views/layouts').reject do |i|
+            i.start_with?('.', '_', 'feather_layout')
+          end.collect{|l| l.split('.').first}
+        end
+      end
+
+      def template_store_path=(value)
+        @@config[:template_store_path] = value
+      end
+
+      def template_store_path
+        @@config[:template_store_path]
+      end
+
+      def template_extenstion=(value)
+        @@config[:template_extenstion] = value
+      end
+
+      def template_extenstion
+        @@config[:template_extenstion] 
+      end
+
+      def layouts
+        @@config[:layouts]
+      end
+
+    end
+
+  end
+end

data/lib/feather_cms/model.rb

@@ -0,0 +1,59 @@
+module FeatherCms
+  module Model
+    module ClassMethods
+      def template_content_field(name)
+        _cms_content_fields_ << name
+        return unless Config.template_store_type == :file 
+
+        attr_accessor name.to_sym
+
+        class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{name}
+            @#{name} || _cms_content(:#{name})
+          end
+        METHOD
+
+        class_eval <<-METHOD, __FILE__, __LINE__ + 1
+          def #{name}_changed?
+            @#{name} != _cms_content(:#{name}) 
+          end
+        METHOD
+      end
+
+      def _cms_content_fields_
+        @_cms_content_fields_ ||= []
+      end
+
+      def define_feather_cms_callbacks
+        after_destroy { |template| 
+          self.class._cms_content_fields_.each do |f|
+            TemplateCache.delete_file(_template_path(f))
+          end
+        }
+
+        after_save { |template|
+          self.class._cms_content_fields_.each do  |f|
+            TemplateCache.write_to_file_and_cache(send(f), template_name(f))
+          end
+        }
+      end
+    end
+
+    module InstanceMethods
+
+      def template_name(field_name)
+        "#{self.class.name.downcase}_#{field_name}_#{self.id}.#{Config.template_extenstion}"
+      end
+
+      def _template_path(field)
+        File.join([Config.template_store_path, template_name(file)])
+      end
+
+      def _cms_content(field)
+        return nil if self.id.nil?
+        TemplateCache.cache_file(template_name(field))
+      end
+
+    end
+  end
+end

data/lib/feather_cms/railtie.rb

@@ -0,0 +1,13 @@
+require 'rails'
+
+module FeatherCms
+  module Railtie
+    class Railtie < ::Rails::Railtie
+      if ::Rails.version.to_f >= 3.1
+        config.before_configuration do |app|
+          app.config.assets.paths << Rails.root.join("app", "assets", "codemirror")
+        end
+      end
+    end
+  end
+end

data/lib/feather_cms/template_cache.rb

@@ -0,0 +1,52 @@
+module FeatherCms
+  class TemplateCache
+    class << self
+
+      def init(options = {})
+        @@_cache ||= {}
+        @@options = options
+      end
+
+      def [](key)
+        @@_cache[key.to_s]   
+      end
+
+      def []=(k,v)
+        @@_cache[k.to_s] = v
+      end
+
+      def cache_file(name)
+        return self[name] if exist?(name)
+
+        file = _file_path(name)
+        self[file] = File.read(file) if File.exist?(file)
+      end
+
+      def write_to_file_and_cache(content, file)
+        return if cache_file(file) == content
+        self[file] = content
+        File.open(_file_path(file), 'wb') {|f| f.write(content) }
+      end
+
+      def exist?(name)
+        @@_cache.key?(name.to_s)
+      end
+
+      def clear(name = nil)
+        name ? @@_cache.delete(name.to_s) : @@_cache.clear
+      end
+
+      def delete_file(name)
+        file = _file_path(name) 
+        File.delete(file) if File.exist?(file)
+        @@_cache.delete(name)
+      end
+
+      private 
+      def _file_path(name)
+        File.join([Config.template_store_path, name])
+      end
+    end
+
+  end
+end

data/lib/feather_cms/version.rb

@@ -0,0 +1,3 @@
+module FeatherCms
+  VERSION = "0.0.1"
+end

data/lib/feather_cms/view_helper.rb

@@ -0,0 +1,20 @@
+module FeatherCms
+  module ViewHelper
+    def feather_cms_include_tag
+      javascript_include_tag('codemirror', 'modes/htmlmixed', 'modes/javascript',
+                             'modes/xml', 'modes/css', 'feather_cms') + 
+      stylesheet_link_tag('codemirror')
+    end
+
+    def feather_cms_template(object_name, method, options = {})
+      options[:class] = "#{options[:class]} codemirror_feather_cms"
+      text_area(object_name, method, options = {})
+    end
+
+    def feather_cms_template_tag(name, content = nil, options = {})
+       options[:class] = "#{options[:class]} codemirror_feather_cms"
+       text_area_tag(name, content = nil, options = {})
+    end
+
+  end
+end

data/lib/feather_cms.rb

@@ -0,0 +1,19 @@
+require "feather_cms/version"
+require "feather_cms/template_cache"
+require "feather_cms/config"
+require "feather_cms/model"
+require "feather_cms/view_helper"
+require "feather_cms/railtie" if defined?(Rails)
+
+module FeatherCms
+  include Model
+
+  def self.included(base)
+    base.extend FeatherCms::Model::ClassMethods
+    if Config.template_store_type == :file 
+      base.define_feather_cms_callbacks
+    end
+    base.template_content_field :content
+    base.send(:include, FeatherCms::Model::InstanceMethods)
+  end
+end

data/lib/generators/feather_cms/USAGE

@@ -0,0 +1,10 @@
+Description:
+  - Feather cms 
+
+
+Example:
+    rails generate feather_cms about_us jobs [storage=file or db]
+
+    This will create:
+      - Add config file 'feather_cms.eb'
+      - Add Codemirror javascript and css

data/lib/generators/feather_cms/feather_cms_generator.rb

@@ -0,0 +1,63 @@
+class FeatherCmsGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :attributes, :type => :array, :banner => "about_us jobs"
+  argument :name, :type => :string, :default => "feather_cms", :required => false 
+  argument :storage, :type => :string , :default => 'file'
+
+  def create_cms_files
+    @pages = attributes.collect(&:name)
+
+    unless ['file', 'db'].include?(storage)
+      puts "Valid storaage type are db,file"
+      storaage = 'file'
+    end
+    @storaage = storaage
+
+    template 'initializer.rb', 'config/initializers/feather_cms.rb'
+    template 'controller.rb', 'app/controllers/feathers_controller.rb'
+    template 'model.rb', 'app/models/feather_page.rb'
+
+    migration_file = Dir.glob("db/migrate/[0-9]*_*.rb").grep(/\d+_create_feather_pages.rb$/).first
+    migration_number = if migration_file 
+                         migration_file.gsub(/_create_feather_pages.rb|db|migrate|\//, '') 
+                       else 
+                         Time.now.utc.to_s.gsub(/[- :UTC]/, '')
+                       end
+
+    template 'migration.rb', "db/migrate/#{migration_number}_create_feather_pages.rb"
+
+    route %{scope '/feathers' do
+    match 'page/:type/(:status)' => 'feathers#page', :as => :feather_page
+    get 'pages' => 'feathers#index', :as => :feather_pages
+    get 'preivew/:type/(:status)' => 'feathers#preivew', :as => 'feather_page_preview'
+  end
+  get 'page/:type' => 'feathers#published', :as => 'feather_published_page'}
+  end
+
+  def copy_view_files
+    @pages = attributes.collect(&:name)
+    base_path = File.join("app/views/feathers")
+    #empty_directory base_path
+    template 'layout.html.erb', 'app/views/layouts/feather_layout.html.erb'
+    template 'index.html.erb', File.join(base_path, 'index.html.erb')
+
+    @pages.each do |type|
+      @type = type
+      @path = File.join(base_path, "#{type}.html.erb")
+      template 'form.html.erb', @path
+    end
+  end
+
+  def add_static_files
+    if Rails.version > '3.0.9'
+      directory 'codemirror', 'app/assets/codemirror'
+      copy_file "bootstrap.css", 'app/assets/stylesheets/bootstrap.css' 
+    else
+      directory 'codemirror', 'public/codemirror'
+      copy_file "bootstrap.css", 'public/stylesheets/bootstrap.css' 
+    end
+  end
+
+
+
+end