very_simple_cms 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c31143f5b3cb58c68b19d9e4583722ad82a2a0b
-  data.tar.gz: e2d0b4572733627fa1f89112ea139eca80cd8a93
+  metadata.gz: e70eb17ddefbfea866529ac40ee167ce4390c3e5
+  data.tar.gz: a7da6847f9a8bfce88c9248af79ac0d0edeb17ed
 SHA512:
-  metadata.gz: b87309ade643ec5b192f17d32dcbfdfc321fe7a8c945022e84625a0532cc1ab6a178424b21a1ec3f23dc3c8c3fe97e9ad921a06e20609a55df4f91fbac6cc2ae
-  data.tar.gz: ec55949c3c1f3e48a6f1e47162bc2cd2a5d9434de922b1470badc460f7a156eb2472b8890170b0887771b563a343c9e54c5753160449c8014388c79c31500542
+  metadata.gz: 4248af94d68464c44306ddb5cff5cbfcef1fef5ec9370051f3693568cbf263a662b83d3a8871355454083c4db92b231202c4ed81761a21789847e3995d6c85d8
+  data.tar.gz: dc2aaf6eebcd6b8334dc90b84f5cf4318a4a6bc34e0f3dc286f96939d5d6141ee708dcdb57bb6a1ce7078d2548de3d4660f120b24cfa29a5e6c7a21a16fbf8ad

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2013 YOURNAME
+Copyright 2013 Eduard Gataullin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -0,0 +1,95 @@
+# Very Simple Cms
+
+Very Simple Cms is a lightweight Content Management System, that support Ruby on Rails 4. Very-Simple-Cms has the simplicity of a static site
+generator, but allows you to
+serve dynamic content on demand.
+
+Content is stored on disk in plain text files (there is no database).
+Edit your content in a text editor and keep it under version control
+(most people use git, but any version control system will do fine).
+
+This CMS is fully support [Mercury Editor](https://github.com/jejacks0n/mercury), and we recomend to use this CMS with this editor to change CMS content
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "very_simple_cms"
+
+And then execute:
+
+    $ bundle
+
+After that run
+
+    $ rails generate very_simple_cms:install
+this code will create file config/initializers/very_simple_cms.rb.
+After that you could change default settings at config/initializers/very_simple_cms.rb
+
+If you would like to use Very Simple Cms with mercury editor, you should add this line to your application's Gemfile:
+
+    gem 'mercury-rails', git: 'git@github.com:jejacks0n/mercury.git', branch: 'master'
+
+After that run
+
+    $ rails generate mercury:install
+
+this command will install mercury editor, we recomend you to install it with layout
+
+    $ rails generate very_simple_cms:init_mercury
+this command will added 2 needed methods to app/assets/javascripts/mercury.js that are needed to integrate mercury editor with VerySimpleCms 
+
+## Usage
+To create a link to your editor (like mercury) use this helper
+
+    cms_edit_link('custom_user_class')
+
+To show text from cms use
+
+    cms_block('title_of_text_area')
+this code will display content that located by default in config/cms/{your_locale}/html_blocks.yml and have following title, also you can change file name and it's path by editing config/initializers/very_simple_cms.rb
+
+##Options
+- **editor path**  
+ `VerySimpleCms.editor_path` 
+it is path to wysiwyg editor that you use in your app 
+- **translate** CMS support I18n. If you want to use multiple languages in your app simply set  
+`VerySimpleCms.translatable = true`  
+this will say cms to use folders that have name of locale to save cms content like  
+`config/cms/{your_locale}/html_blocks.yml`  
+if you set  
+`VerySimpleCms.translatable = false`  
+cms will save changes in path like  
+`config/cms/{your_locale}/html_blocks.yml`  
+- **name of yml file** You can change filename to save changes like  
+`VerySimpleCms.source_file_name = '/html_blocks'
+- **source files root** You can change path to save changes like  
+  `VerySimpleCms.source_files_root = "config/cms/"`
+
+##Caching
+This Cms use yml files to save user data, but reading from disk is very slow, so to improve your application pervomance you should use caching.  
+Very-Simple-Cms fully support caching, so to cash all cms fragments simple set
+
+    config.action_controller.perform_caching = true
+
+to learn more about caching that rails provides visit [Ruby on Rails Guides](http://guides.rubyonrails.org/caching_with_rails.html)
+
+
+##Example
+VerySimpleCms have build in simple test and example application that located in 'test/dummy' path
+
+To run this app you should firstly clone VerySimpleCms project
+    
+    git clone git@github.com:edikgat/very_simple_cms.git
+    
+than
+
+    cd very_simple_cms/test/dummy
+
+and run rails server
+
+    rails s
+
+## P.S.
+This CMS was tested only with Mercury editor and Rails 4 framework

data/app/controllers/very_simple_cms/application_controller.rb

@@ -1,5 +1,7 @@
 module VerySimpleCms
   class ApplicationController < ActionController::Base
     include SharedHelper
+    include ApplicationHelper
+
   end
 end

data/app/controllers/very_simple_cms/contents_controller.rb

@@ -17,6 +17,7 @@ module VerySimpleCms
           )
           static_text.save
         end
+        Rails.cache.write(cache_name_string(key), (static_text.try(:body).html_safe))
       end
       render text: ""
     end

data/app/helpers/very_simple_cms/application_helper.rb

@@ -1,4 +1,8 @@
 module VerySimpleCms
   module ApplicationHelper
+    def cache_name_string(title, save_source = nil )
+      save_source ||= dynamic_save_source
+      "verysimplecms::htmlblocks/#{save_source}/#{title}"
+    end
   end
 end

data/app/helpers/very_simple_cms/cms_helper.rb

@@ -1,7 +1,10 @@
 module VerySimpleCms
   module CmsHelper
     def cms_block(title)
-      raw(HtmlBlock.find_by_attribute(dynamic_save_source, :title, title).try(:body))
+      Rails.cache.fetch(cache_name_string(title)) do
+        block = HtmlBlock.find_by_attribute(dynamic_save_source, :title, title)
+        raw(block.try(:body))
+      end
     end
 
     def cms_edit_link(advanced_class=nil)

data/app/models/very_simple_cms/html_block.rb

@@ -1,14 +1,15 @@
 module VerySimpleCms
   class HtmlBlock < YamlRecord::Base
     include SharedHelper
-    properties :title, :body, :dynamic_source
+    properties :title, :body, :dynamic_source, :updated_at
     adapter :local
     source Rails.root.join(VerySimpleCms.source_files_root)
     source_file_name VerySimpleCms.source_file_name
     before_create :set_dynamic_source
+    before_save :set_updated_at
 
     def to_s
-        {title: title, body: body,  dynamic_source: dynamic_source}.to_s
+        {title: title, body: body,  dynamic_source: dynamic_source, updated_at: updated_at}.to_s
     end
 
     private
@@ -17,5 +18,9 @@ module VerySimpleCms
             self.dynamic_source = dynamic_save_source
         end
     end
+
+    def set_updated_at
+        self.updated_at = Time.zone.now.to_s :bd
+    end
   end
 end

data/lib/very_simple_cms/engine.rb

@@ -6,6 +6,7 @@ module VerySimpleCms
       ActiveSupport.on_load :action_controller do
         helper VerySimpleCms::CmsHelper
         helper VerySimpleCms::SharedHelper
+        helper VerySimpleCms::ApplicationHelper
       end
     end
   end

data/lib/very_simple_cms/version.rb

@@ -1,3 +1,3 @@
 module VerySimpleCms
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/dummy/README.md

@@ -0,0 +1,16 @@
+# Very Simple Cms test application
+
+This application use [mercury-editor](https://github.com/jejacks0n/mercury) as editor of cms content, to support latest versions of jquery and work with mercury editor it use [jquery-migrate plugin](https://github.com/jquery/jquery-migrate/).
+
+## Installation
+
+    $ cd test/dummy
+    $ bundle
+
+## Usage
+Simple run
+
+    $ rails s
+
+to edit content click to 'edit' link
+

data/test/dummy/config/cms/en/html_blocks.yml

@@ -2,4 +2,5 @@
 - :title: first
   :body: It works!
   :dynamic_source: en
+  :updated_at: '2013-09-30 13:23:08 UTC'
   :id: 3f7adda07e9887265fb380df676024

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: very_simple_cms
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Eduard Gataullin, Ruslan Hamidullin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-26 00:00:00.000000000 Z
+date: 2013-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,72 +52,80 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/assets/javascripts/very_simple_cms/application.js
-- app/assets/stylesheets/very_simple_cms/application.css
-- app/controllers/very_simple_cms/application_controller.rb
-- app/controllers/very_simple_cms/contents_controller.rb
-- app/helpers/very_simple_cms/cms_helper.rb
+- app/models/very_simple_cms/html_block.rb
 - app/helpers/very_simple_cms/application_helper.rb
 - app/helpers/very_simple_cms/shared_helper.rb
-- app/models/very_simple_cms/html_block.rb
-- config/locales/en.yml
+- app/helpers/very_simple_cms/cms_helper.rb
+- app/controllers/very_simple_cms/application_controller.rb
+- app/controllers/very_simple_cms/contents_controller.rb
+- app/assets/javascripts/very_simple_cms/application.js
+- app/assets/stylesheets/very_simple_cms/application.css
 - config/routes.rb
-- lib/very_simple_cms/version.rb
-- lib/very_simple_cms/engine.rb
-- lib/very_simple_cms.rb
+- config/locales/en.yml
 - lib/generators/very_simple_cms/init_mercury/USAGE
 - lib/generators/very_simple_cms/init_mercury/init_mercury_generator.rb
 - lib/generators/very_simple_cms/install/USAGE
 - lib/generators/very_simple_cms/install/install_generator.rb
 - lib/generators/very_simple_cms/install/templates/very_simple_cms.rb
+- lib/very_simple_cms/version.rb
+- lib/very_simple_cms/engine.rb
 - lib/tasks/very_simple_cms_tasks.rake
+- lib/very_simple_cms.rb
 - MIT-LICENSE
 - Rakefile
-- test/integration/navigation_test.rb
-- test/very_simple_cms_test.rb
+- README.md
 - test/controllers/very_simple_cms/mercury_controller_test.rb
-- test/test_helper.rb
-- test/helpers/very_simple_cms/cms_helper_test.rb
-- test/helpers/very_simple_cms/mercury_helper_test.rb
-- test/dummy/bin/rails
+- test/dummy/README.md
+- test/dummy/Rakefile
+- test/dummy/app/assets/images/.keep
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/javascripts/jquery-migrate-1.2.1.js
+- test/dummy/app/assets/javascripts/mercury.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/assets/stylesheets/mercury.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/concerns/.keep
+- test/dummy/app/controllers/home_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/.keep
+- test/dummy/app/models/.keep
+- test/dummy/app/models/concerns/.keep
+- test/dummy/app/views/home/index.html.erb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/layouts/mercury.html.erb
 - test/dummy/bin/bundle
+- test/dummy/bin/rails
 - test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
 - test/dummy/config/cms/en/html_blocks.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/very_simple_cms.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/application.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/very_simple_cms.rb
+- test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/routes.rb
-- test/dummy/config/boot.rb
-- test/dummy/README.rdoc
+- test/dummy/lib/assets/.keep
+- test/dummy/log/.keep
 - test/dummy/public/404.html
-- test/dummy/public/500.html
 - test/dummy/public/422.html
+- test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/config.ru
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/javascripts/mercury.js
-- test/dummy/app/assets/javascripts/jquery-migrate-1.2.1.js
-- test/dummy/app/assets/stylesheets/mercury.css
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/views/layouts/mercury.html.erb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/home/index.html.erb
-- test/dummy/app/controllers/home_controller.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
 - test/dummy/test/controllers/home_controller_test.rb
 - test/dummy/test/helpers/home_helper_test.rb
+- test/helpers/very_simple_cms/cms_helper_test.rb
+- test/helpers/very_simple_cms/mercury_helper_test.rb
+- test/integration/navigation_test.rb
+- test/test_helper.rb
+- test/very_simple_cms_test.rb
 homepage: https://github.com/edikgat/very_simple_cms
 licenses:
 - MIT
@@ -138,53 +146,60 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: Ruby CMS, written in Ruby on Rails and use YML files to store content
 test_files:
-- test/integration/navigation_test.rb
-- test/very_simple_cms_test.rb
 - test/controllers/very_simple_cms/mercury_controller_test.rb
-- test/test_helper.rb
-- test/helpers/very_simple_cms/cms_helper_test.rb
-- test/helpers/very_simple_cms/mercury_helper_test.rb
-- test/dummy/bin/rails
+- test/dummy/README.md
+- test/dummy/Rakefile
+- test/dummy/app/assets/images/.keep
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/javascripts/jquery-migrate-1.2.1.js
+- test/dummy/app/assets/javascripts/mercury.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/assets/stylesheets/mercury.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/controllers/concerns/.keep
+- test/dummy/app/controllers/home_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/mailers/.keep
+- test/dummy/app/models/.keep
+- test/dummy/app/models/concerns/.keep
+- test/dummy/app/views/home/index.html.erb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/app/views/layouts/mercury.html.erb
 - test/dummy/bin/bundle
+- test/dummy/bin/rails
 - test/dummy/bin/rake
+- test/dummy/config.ru
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
 - test/dummy/config/cms/en/html_blocks.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/filter_parameter_logging.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/very_simple_cms.rb
 - test/dummy/config/initializers/inflections.rb
 - test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/application.rb
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/very_simple_cms.rb
+- test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/routes.rb
-- test/dummy/config/boot.rb
-- test/dummy/README.rdoc
+- test/dummy/lib/assets/.keep
+- test/dummy/log/.keep
 - test/dummy/public/404.html
-- test/dummy/public/500.html
 - test/dummy/public/422.html
+- test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/dummy/Rakefile
-- test/dummy/config.ru
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/javascripts/mercury.js
-- test/dummy/app/assets/javascripts/jquery-migrate-1.2.1.js
-- test/dummy/app/assets/stylesheets/mercury.css
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/views/layouts/mercury.html.erb
-- test/dummy/app/views/layouts/application.html.erb
-- test/dummy/app/views/home/index.html.erb
-- test/dummy/app/controllers/home_controller.rb
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
 - test/dummy/test/controllers/home_controller_test.rb
 - test/dummy/test/helpers/home_helper_test.rb
+- test/helpers/very_simple_cms/cms_helper_test.rb
+- test/helpers/very_simple_cms/mercury_helper_test.rb
+- test/integration/navigation_test.rb
+- test/test_helper.rb
+- test/very_simple_cms_test.rb

data/test/dummy/README.rdoc

@@ -1,28 +0,0 @@
-== README
-
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
-
-
-Please feel free to use a different markup language if you do not plan to run
-<tt>rake doc:app</tt>.