mcms_pages 0.0.1

data/db/seeds.rb

@@ -0,0 +1,175 @@
+=begin
+
+  @File Name                 : seeds.rb
+  @Company Name              : Mindfire Solutions Private Limited
+  @Creator Name              : Vikram Kumar Mishra
+  @Date Created              : 2012-06-05
+  @Date Modified             : 2012-06-19
+  @Last Modification Details : modified to create records in DB.
+  @Purpose                   : This file should contain all the record creation needed to seed the database with its default values,
+                               The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+
+=end
+
+if Layout.all.empty?
+
+  Layout.create({
+
+        :name => "one column",
+        :left => 0,
+        :right => 0,
+        :main => 1,
+        :header => 1,
+        :footer => 1,
+        :column_count => 1
+
+    })
+   Layout.create({
+
+        :name => "two column with right",
+        :left => 0,
+        :right => 1,
+        :main => 1,
+        :header => 1,
+        :footer => 1,
+        :column_count => 2
+
+    })
+   Layout.create({
+
+        :name => "two column with left",
+        :left => 1,
+        :right => 0,
+        :main => 1,
+        :header => 1,
+        :footer => 1,
+        :column_count => 2
+
+    })
+   Layout.create({
+
+        :name => "three column",
+        :left => 1,
+        :right => 1,
+        :main => 1,
+        :header => 1,
+        :footer => 1,
+        :column_count => 3
+
+    })
+
+   Layout.create({
+
+        :name => "default",
+        :left => 0,
+        :right => 0,
+        :main => 1,
+        :header => 0,
+        :footer => 0,
+        :column_count => 0
+
+    })
+
+
+end
+
+if Page.where(:link_url => "/").empty?
+
+  home_page = Page.create!({
+
+              :title => "Home",
+              :link_url => "/home",
+              :layout_id => "1"
+
+            })
+
+  home_page.page_parts.create({
+
+                :title => "header",
+                :body => "<p>Header Part of the page.</p>"
+
+            })
+
+  home_page.page_parts.create({
+
+              :title => "footer",
+              :body => "<p>Footer part of the page</p>"
+
+            })
+
+  home_page.page_parts.create({
+
+                :title => "main Body",
+                :body => "<p>Welcome to our site. This is just a place holder page while we gather our content.</p>"
+
+            })
+
+
+  page_not_found_page = home_page.children.create({
+
+              :title => "Page not found",
+              :link_url => "/404",
+              :show_in_menu => false,
+              :layout_id => "1",
+              :published => true
+
+            })
+
+  page_not_found_page.page_parts.create({
+
+                :title => "header",
+                :body => ""
+
+            })
+
+  page_not_found_page.page_parts.create({
+
+                :title => "footer",
+                :body => ""
+
+            })
+
+  page_not_found_page.page_parts.create({
+
+                :title => "main body",
+                :body => "<h2>Sorry, there was a problem...</h2><p>The page you requested was not found.</p><p><a href='/'>Return to the home page</a></p>"
+
+            })
+end
+
+if Page.find_by_title("About").nil?
+
+  about_us_page = Page.create({
+
+                 :title => "About",
+                 :layout_id => "1",
+                 :published => "1",
+                 :show_in_menu => "1"
+
+            })
+
+  about_us_page.page_parts.create({
+
+                :title => "header",
+                :body => "<p>Header Part of the page About.</p>"
+            })
+
+  about_us_page.page_parts.create({
+
+              :title => "footer",
+              :body => "<p>Footer part of the page About</p>"
+
+            })
+
+  about_us_page.page_parts.create({
+
+                :title => "main body",
+                :body => "<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus fringilla nisi a elit.
+                             Duis ultricies orci ut arcu. Ut ac nibh. Duis blandit rhoncus magna. Pellentesque semper risus ut magna.
+                             Etiam pulvinar tellus eget diam. Morbi blandit. Donec pulvinar mauris at ligula. Sed pellentesque, ipsum id
+                             congue molestie, lectus risus egestas pede, ac viverra diam lacus ac urna. Aenean elit.</p>"
+
+            })
+
+end
+

data/lib/generators/mcms_pages/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate mcms_pages Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/mcms_pages/assets_generator.rb

@@ -0,0 +1,79 @@
+=begin
+
+  @File Name                            : assets_generator.rb
+	@Company Name                         : Mindfire Solutions Pvt. Ltd.
+	@Creator Name                         : Vikram Kumar Mishra
+	@Date Created                         : 2012-07-09
+  @Date Modified                        :
+  @Last Modification Details            :
+  @Purpose                              : This file is responsible to install assets and views for mcms_pages module in other application/module
+
+=end
+
+module McmsPages
+
+  module Generators
+
+    # To generate Pages views.
+    # copy_views` is the main method and by default copies all views
+    module AssetPathTemplates
+      extend ActiveSupport::Concern
+
+      included do
+
+        public_task :copy_assets
+
+      end
+
+      # @Params     : None
+      # @Returns    : None
+      # @Purpose    : To copy stylesheets
+      def copy_assets
+
+        view_directory :mcms_pages
+
+      end # end method
+
+      protected
+
+      # @Params     : None
+      # @Returns    : None
+      # @Purpose    : To define the source path to copy views
+      def view_directory(name, _target_path = nil)
+
+        directory name.to_s, _target_path || "#{target_path}/#{name}"
+
+      end # end method
+
+      # @Params     : None
+      # @Returns    : None
+      # @Purpose    : To define the target path to copy views
+      def target_path
+
+        @target_path ||= "app/assets/stylesheets"
+
+      end # end method
+
+    end # end module ViewPathTemplates
+
+
+    class AssetsGenerator < Rails::Generators::Base
+
+      include AssetPathTemplates
+      source_root File.expand_path("../../../../app/assets/stylesheets", __FILE__)
+
+      # @Params     : None
+      # @Returns    : None
+      # @Purpose    : Just to print a line on console
+      def install_assets
+
+        say "MCMS PAGES Assets created to your application."
+
+      end # end method
+
+    end # end class
+
+  end # end module Generators
+
+end # end module McmsPages
+

data/lib/generators/mcms_pages/mcms_pages_generator.rb

@@ -0,0 +1,101 @@
+=begin
+
+  @File Name                            : mcms_pagesn_generator.rb
+	@Company Name                         : Mindfire Solutions Pvt. Ltd.
+	@Creator Name                         : Vikram Kumar Mishra
+	@Date Created                         : 2012-07-06
+  @Date Modified                        :
+  @Last Modification Details            :
+  @Purpose                              : This file is responsible to install mcms_pages module in other application/module
+
+=end
+
+class McmsPagesGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+
+  # @Params     : None
+  # @Returns    : None
+  # @Purpose    : Just to print a line on console
+  def install_pages
+
+    say "Installing MCMS_PAGES MODULE"
+
+  end # end method
+
+  # @Params     : None
+  # @Returns    : None
+  # @Purpose    : To Copy asset_manager from engine to app
+  def copy_asset_manager
+
+    #copy file lib/asset_manager.rb to app/lib/asset_manager.rb if it doesn't exists
+    copy_file "asset_manager.rb", "lib/asset_manager.rb" unless File.exists?(File.join(destination_root, 'lib', 'asset_manager.rb'))
+
+
+  end # end method
+
+  # @Params     : None
+  # @Returns    : None
+  # @Purpose    : To Copy ckeditor initializer from engine to app
+  def copy_initializer
+
+    #copy file lib/asset_manager.rb to app/lib/asset_manager.rb if it doesn't exists
+    copy_file "ckeditor.rb", "config/initializers/ckeditor.rb" unless File.exists?(File.join(destination_root, 'config/initializers', 'ckeditor.rb'))
+
+
+  end # end method
+
+  # @Params     : None
+  # @Returns    : None
+  # @Purpose    : To Copy all the migrations from db/migrate of engine to db/migrate of application
+  def add_migrations
+
+    say "copying migrations......."
+
+    # running command line command to copy engine's migration file
+    rake("mcms_pages_engine:install:migrations")
+
+  end # end method
+
+  # @Params     : None
+  # @Returns    : None
+  # @Purpose    : To append seeds data from engine to app's seeds.rb
+  def append_seed_data
+
+      # create file deb/seeds.rb to parent app if not exists
+      create_file "db/seeds.rb" unless File.exists?(File.join(destination_root, 'db', 'seeds.rb'))
+
+      # append data to app's seeds.rb
+      append_file 'db/seeds.rb', :verbose => true do
+
+        <<-EOH
+
+        McmsPages::Engine.load_seed
+
+        EOH
+
+      end # end block
+
+  end # end method
+
+
+  # @Params     : None
+  # @Returns    : None
+  # @Purpose    : To prompt user for some instrctions on console
+  def prompt_user
+
+    say "\ndon't forget to run the following \n
+
+          rake db:migrate\n
+
+          rake db:seed\n
+
+          Add the line\n\n\t\t root :to => 'pages#home'\n\n\t in config/routes.rb file \n
+
+          start the rails server and hit the url http://localhost:3000/mcms/pages\n
+
+          Yay!\n\n"
+
+  end# end method
+
+end
+

data/lib/generators/mcms_pages/templates/asset_manager.rb

@@ -0,0 +1,160 @@
+=begin
+
+  @File Name                 : lib/asset_manager.rb
+  @Company Name              : Mindfire Solutions Private Limited
+  @Creator Name              : Vikram Kumar Mishra
+  @Date Created              : 2012-06-09
+  @Date Modified             : 
+  @Last Modification Details : 
+  @Purpose                   : To include controller action specific JS and CSS.
+
+=end
+
+class AssetManager
+
+  # @param = mixed
+  # @return = none
+  # To include individual CSS file
+  def self.include_css file
+
+    # if param is of type Array
+    if file.class == Array
+
+      # loop through the param and include all files one by one
+      file.each do |f|
+
+        #calling include_css_file_individual to include css file
+        include_css_file_individual f
+        
+      end # end each loop
+      
+    else
+      
+      #calling include_css_file_individual to include css file
+      include_css_file_individual file
+
+    end # end if
+    
+  end # end class method include_css
+
+  # @param = mixed
+  # @return = none
+  # TO include all JS file
+  def self.include_local_library library
+
+    #calling include_js_library to include specific JS files
+    include_js_library library, :local
+    
+  end # end class method include_local_library
+
+  # @params = mixed(JS files) and type of library
+  # @return = none
+  # To include JS files
+  def self.include_js_library library, type = :local
+
+    #if param is of type array
+    if library.class == Array
+      
+      # loop through the param and include all JS files one by one
+      library.each do |l|
+
+        #calling include_js_library_individual to include js file
+        include_js_library_individual l, type
+        
+      end # end each loop
+      
+    else
+      
+       #calling include_js_library_individual to include js file
+      include_js_library_individual library, type
+      
+    end # end if
+    
+  end # end class method include_js_library
+
+
+  # @param = none
+  # @return = Array
+  def self.get_libraries
+
+    # return class array
+    return @@js_includes
+    
+  end # end class method get_libraries
+
+  # @param = none
+  # @return = Array
+  def self.get_css
+
+    # return class array
+    return @@css_includes
+    
+  end # end class method get_css
+
+
+  # declaring private section to be visible within the class only
+  private
+
+  # declaring class variable of type array
+  @@js_includes = []
+  @@css_includes = []
+
+  
+  def self.include_js_library_individual library, type
+
+    # declare a local variable of type string with empty value
+    file = ""
+
+    # checking the type of param name type
+    case type
+      
+      when :local # when it is local
+
+        # check if the class of param library is symbol
+        if library.class == Symbol
+          
+           # convert symbols into string and assign it to variable file
+          file = library.to_s + ".js"
+          
+        else
+
+          #assign the name in file variable
+          file = library
+          
+        end
+        
+#      when :contrib
+#      
+#        file = "contrib/" + @@libraries[library]
+
+    end # end case statement
+
+    # include the file into the array
+    @@js_includes << file unless file.blank? or @@js_includes.include? file
+
+  end # end private class method include_js_library_individual
+
+
+  # @param = string or symbol
+  # @return = class variable of type array
+  def self.include_css_file_individual file
+
+    # if params belongs to symbol class
+    if file.class == Symbol
+
+      # convert symbols into string
+      file = file.to_s + '.css'
+      
+    end # end if
+
+    # include the file into the array
+    @@css_includes << file  unless file.blank? or @@css_includes.include? file
+    
+  end # end private class method include_css_file_individual
+
+  # declaring class variable of type hash
+  @@libraries = {
+    # declare the library file here in hash format
+  }
+
+end # end AssetManager Class

data/lib/generators/mcms_pages/templates/ckeditor.rb

@@ -0,0 +1,18 @@
+# Use this hook to configure ckeditor
+if Object.const_defined?("Ckeditor")
+  Ckeditor.setup do |config|
+    # ==> ORM configuration
+    # Load and configure the ORM. Supports :active_record (default), :mongo_mapper and
+    # :mongoid (bson_ext recommended) by default. Other ORMs may be
+    # available as additional gems.
+    require "ckeditor/orm/active_record"
+
+    # Allowed image file types for upload.
+    # Set to nil or [] (empty array) for all file types
+    # config.image_file_types = ["jpg", "jpeg", "png", "gif", "tiff"]
+
+    # Allowed attachment file types for upload.
+    # Set to nil or [] (empty array) for all file types
+    # config.attachment_file_types = ["doc", "docx", "xls", "odt", "ods", "pdf", "rar", "zip", "tar", "swf"]
+  end
+end

data/lib/generators/mcms_pages/views_generator.rb

@@ -0,0 +1,79 @@
+=begin
+
+  @File Name                            : views_generator.rb
+	@Company Name                         : Mindfire Solutions Pvt. Ltd.
+	@Creator Name                         : Vikram Kumar Mishra
+	@Date Created                         : 2012-07-09
+  @Date Modified                        :
+  @Last Modification Details            :
+  @Purpose                              : This file is responsible to install assets and views for mcms_pages module in other application/module
+
+=end
+
+module McmsPages
+
+  module Generators
+
+    # To generate Pages views.
+    # copy_views` is the main method and by default copies all views
+    module ViewPathTemplates
+      extend ActiveSupport::Concern
+
+      included do
+
+        public_task :copy_views
+
+      end
+
+      # @Params     : None
+      # @Returns    : None
+      # @Purpose    : To copy views
+      def copy_views
+
+        view_directory :mcms_pages
+
+      end # end method
+
+      protected
+
+      # @Params     : None
+      # @Returns    : None
+      # @Purpose    : To define the source path to copy views
+      def view_directory(name, _target_path = nil)
+
+        directory name.to_s, _target_path || "#{target_path}/#{name}"
+
+      end # end method
+
+      # @Params     : None
+      # @Returns    : None
+      # @Purpose    : To define the target path to copy views
+      def target_path
+
+        @target_path ||= "app/views"
+
+      end # end method
+
+    end # end module ViewPathTemplates
+
+
+    class ViewsGenerator < Rails::Generators::Base
+
+      include ViewPathTemplates
+      source_root File.expand_path("../../../../app/views", __FILE__)
+
+      # @Params     : None
+      # @Returns    : None
+      # @Purpose    : Just to print a line on console
+      def install_views
+
+        say "MCMS PAGES views created to your application."
+
+      end # end method
+
+    end # end class
+
+  end # end module Generators
+
+end # end module McmsPages
+

data/lib/mcms_pages/engine.rb

@@ -0,0 +1,13 @@
+module McmsPages
+  class Engine < ::Rails::Engine
+
+    require 'paperclip'
+    require 'ckeditor'
+    require 'foreigner'
+
+    config.autoload_paths += %W( #{config.root}/lib )
+    config.autoload_paths += Dir["#{config.root}/lib/**/"]
+
+  end
+end
+

data/lib/mcms_pages/version.rb

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

data/lib/mcms_pages.rb

@@ -0,0 +1,7 @@
+require "mcms_pages/engine"
+
+module McmsPages
+
+
+end
+

data/lib/tasks/mcms_pages_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mcms_pages do
+#   # Task goes here
+# end