faalis 0.26.3 → 1.0.0.alpha0

data/lib/faalis/engine.rb

@@ -21,7 +21,6 @@ require 'modernizr-rails'
 require 'foundation-rails'
 require 'font-awesome-rails'
 require 'cancan'
-require 'mailboxer'
 require 'model_discovery'
 require 'angularjs-rails'
 require 'lodash-rails'
@@ -31,8 +30,9 @@ module Faalis
   class Engine < ::Rails::Engine
 
     isolate_namespace Faalis
-    engine_name "faalis"
+    engine_name 'faalis'
 
+    # Map `api` to `API` in Rails autoload
     ActiveSupport::Inflector.inflections(:en) do |inflect|
       inflect.acronym 'API'
     end
@@ -64,14 +64,29 @@ module Faalis
     mattr_accessor :dashboard_namespace
     @@dashboard_namespace = :dashboard
 
+    # TODO: Use application level locales default
     # locales
     mattr_accessor :locales
     @@locales = ['en', 'fa']
 
+    # ==> ORM configuration
+    # Load and configure the ORM. Supports :active_record (default) and
+    # :mongoid (bson_ext recommended) by default. Other ORMs may be
+    # available as additional gems.
+    # ORM name to use. either 'active_record' or 'mongoid'
+    mattr_accessor :orm
+
+    def self.orm=(orm_name)
+      @@orm = orm_name
+      require "devise/orm/#{orm_name}"
+      #require 'mailboxer'
+    end
+
     def self.setup
       yield self
     end
 
+    # I18n Configuration
     I18n.enforce_available_locales = true
     I18n.locale = :en
     # Fast Gettext Configuration
@@ -100,7 +115,7 @@ module Faalis
     end
     #Devise.omniauth_path_prefix = ["/en", "/fa"]
 
-
+    # TODO: Write a complete doc about dashboard_modules
     # Dashboard configurations
     mattr_accessor :dashboard_modules
 
@@ -118,13 +133,12 @@ module Faalis
 
 
     def self.dashboard_modules=(value)
-        @@dashboard_modules.merge!(value)
+      @@dashboard_modules.merge!(value)
     end
 
     # Dashboard default javascript manifest
     mattr_accessor :dashboard_js_manifest
     @@dashboard_js_manifest = "controlpanel/application.js"
 
-    config.autoload_paths << "app/workflows"
   end
 end

data/lib/faalis/extensions.rb

@@ -0,0 +1,18 @@
+module Faalis
+  # Extension module of Faalis which contains all the related
+  # stuff to a Faalis extension.
+  module Extension
+
+    @@extensions = {}
+
+    def self.extensions
+      @@extensions
+    end
+
+    def self.extensions=(value)
+      @@extensions = value
+    end
+  end
+end
+
+require 'faalis/extensions/base'

data/lib/faalis/extensions/base.rb

@@ -0,0 +1,29 @@
+module Faalis
+  module Extension
+    # This module provide basic functionallity of a Faalis extension
+    # to a rails engine.
+    # It should be included in engine of all the Faalis extionsions
+    module Base
+
+      def included(base)
+        extend ClassMethods
+      end
+
+      class ClassMethods
+        def register_extension(name, klass)
+          # TODO: Replace this mechanism with more elegant one
+          #       For example use [] method or someting
+          Faalis::Extension.extensions[name] = klass
+        end
+
+        # This method tells faalis that this extension will override
+        # the generators templates of faalis from `template_path` location
+        def override_generator_templates(template_path)
+          send(:define_singleton_method, 'generator_templates_path') do
+            template_path
+          end
+        end
+      end
+    end
+  end
+end

data/lib/faalis/fake_assets.rb

@@ -0,0 +1,7 @@
+require 'rails-assets-angular-gettext'
+require 'rails-assets-ng-grid'
+require 'rails-assets-restangular'
+require 'rails-assets-ngQuickDate'
+require 'rails-assets-select2'
+require 'rails-assets-angular-ui-select2'
+require 'rails-assets-ng-flow'

data/lib/faalis/generators/dashboard_scaffold.rb

@@ -5,7 +5,7 @@ module Faalis
     # easier. But you can drive your own generator normally of caurse
     class DashboardScaffold < Rails::Generators::Base
 
-      include ActionView::Helpers::TextHelper
+      include ::ActionView::Helpers::TextHelper
       include Faalis::Generators::Concerns::JsonInput
       include Faalis::Generators::Concerns::ResourceName
       include Faalis::Generators::Concerns::ResourceFields
@@ -23,16 +23,34 @@ module Faalis
       include Faalis::Generators::Concerns::Fieldset
 
       # Do not install specs
-      class_option :without_specs, :type => :boolean, :default => false, :desc => 'Do not install specs'
+      class_option :without_specs, type: :boolean, default: false, desc: 'Do not install specs'
 
       # Generate only spec files
-      class_option :only_specs, :type => :boolean, :default => false, :desc => 'Generate only spec files'
+      class_option :only_specs, type: :boolean, default: false, desc: 'Generate only spec files'
 
       # Generate only controller
-      class_option :only_controller, :type => :boolean, :default => false, :desc => 'Generate only controller'
+      class_option :only_controller, type: :boolean, default: false, desc: 'Generate only controller'
 
       # Don't show a filter box
-      class_option :no_filter, :type => :boolean, :default => false, :desc => 'Don\'t view a filter box'
+      class_option :no_filter, type: :boolean, default: false, desc: 'Don\'t view a filter box'
+
+
+      private
+
+      # Overrided `source_paths` method. With this approach extensions
+      # can override generators templates. Cool ha ?
+      def source_paths
+        @source_paths = self.class.source_paths_for_search
+
+        paths = []
+        Faalis::Extension.extensions.each do |name, klass|
+          if klass.respond_to? :generator_templates_path.to_sym
+            paths << klass.generator_templates_path
+          end
+        end
+        paths += @source_paths
+        @source_paths = paths
+      end
 
 
     end

data/lib/faalis/omniauth.rb

@@ -19,6 +19,9 @@
 
 module Faalis
   module Omniauth
+    # TODO: Autoload ? really ?
+    #       Change it ASAP. Remember that callback should
+    #       not included if host project does not have omniauth enabled
     autoload :Callbacks, "faalis/omniauth/callbacks"
   end
 end

data/lib/faalis/orm.rb

@@ -0,0 +1,29 @@
+module Faalis
+  # A very simple class which provide functionalities to work with
+  # current orm
+  class ORM
+
+    def self.active_record?
+      current == 'active_record'
+    end
+
+    def self.mongoid?
+      current == 'mongoid'
+    end
+
+    # current orm
+    def self.current
+      Faalis::Engine.orm.to_s
+    end
+
+    # This class method returns the base class of current ORM
+    # It will be used in models to specify which class to inherit
+    # from, based on current ORM
+    def self.proper_base_class
+      return ActiveRecord::Base if active_record?
+      return Object if mongoid?
+      Faalis::Engine.orm = 'active_record'
+      ActiveRecord::Base
+    end
+  end
+end

data/lib/faalis/{active_record.rb → patches/models.rb}

@@ -1,9 +1,7 @@
 # Add inline permissions to any active record models. So we can use them
 # to authorize user access.
-
-
 module ActiveRecord
   class Base
-    include Faalis::Permissions
+    include Faalis::Concerns::Authorizable
   end
 end

data/lib/faalis/version.rb

@@ -18,5 +18,5 @@
 # -----------------------------------------------------------------------------
 
 module Faalis
-  VERSION = "0.26.3"
+  VERSION = '1.0.0.alpha0'
 end

data/lib/generators/faalis/install_generator.rb

@@ -26,9 +26,9 @@ module Faalis
       desc 'Copy all the necessary files to use Faalis'
       class_option :orm
 
-      def install_mailboxer
-        invoke 'mailboxer:install'
-      end
+      #def install_mailboxer
+      #  invoke 'mailboxer:install'
+      #end
 
       def install_model_discovery
         rake 'model_discovery_engine:install:migrations'
@@ -48,6 +48,10 @@ module Faalis
         empty_directory "#{angularjs_app_path}modules"
       end
 
+      def grunt_file
+        template 'i18n/Gruntfile.js.erb', 'lib/tasks/grunt/Gruntfile.js'
+      end
+
       def copy_scss_manifest
         directory 'stylesheets', 'app/assets/stylesheets'
       end

data/lib/{faalis/plugins.rb → generators/faalis/js/install_i18n_generator.rb}

@@ -17,28 +17,31 @@
 #    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 # -----------------------------------------------------------------------------
 
-
 module Faalis
-  class Plugins
+  module Generators
+    module Js
+      # Generator responsible for `install_i18n` generator
+      class InstallI18nGenerator < Rails::Generators::Base
+        source_root File.expand_path('../../templates/', __FILE__)
 
-    @@plugins = {}
+        desc 'Copy all the necessary files to use Faalis client side i18n'
 
-    def self.register(plugin_name, plugin_class)
-      # TODO: Re-think this approach. Do we need to keep plugin classes too?
-      if not @@plugins.include? plugin_name
-        @@plugins[plugin_name] = plugin_class
-      end
-    end
+        def copy_init_files
+          template 'i18n/Gruntfile.js.erb', 'lib/tasks/grunt/Gruntfile.js'
+          copy_file 'i18n/fa.js', 'app/assets/javascripts/locale/'
+        end
 
-    # Return name of all registered plugins
-    def self.names
-      @@plugins.keys
-    end
+        def show_readme
+          readme 'i18n/README' if behavior == :invoke
+        end
 
-    # Return the actual plugins hash
-    def self.plugins
-      @@plugins
-    end
+        private
 
+        def angularjs_app_path
+          path = Faalis::Engine.dashboard_js_manifest.split('/')[0..-2].join('/')
+          "app/assets/javascripts/#{path}/"
+        end
+      end
+    end
   end
 end

data/lib/generators/faalis/scaffold_generator.rb

@@ -0,0 +1,139 @@
+# -----------------------------------------------------------------------------
+#    Faalis - Basic website skel engine
+#    Copyright (C) 2012-2014 Yellowen
+#
+#    This program is free software; you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation; either version 2 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License along
+#    with this program; if not, write to the Free Software Foundation, Inc.,
+#    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# -----------------------------------------------------------------------------
+
+module Faalis
+  module Generators
+    # Generator Full Faalis scaffold with dashboard
+    class ScaffoldGenerator < Rails::Generators::Base
+      include Faalis::Generators::Concerns::RequireFields
+      include Faalis::Generators::Concerns::Parent
+      include Faalis::Generators::Concerns::JsonInput
+      include Faalis::Generators::Concerns::ResourceName
+      include Faalis::Generators::Concerns::ResourceFields
+
+      desc 'Create full faalis full scaffold'
+      # FIXME: These options should have :type and :desc or even default
+      #        value
+      class_option :no_model
+      class_option :no_route
+      class_option :no_controller
+      class_option :no_migration
+      class_option :no_asset
+
+      # FIXME: Add method documents HERE
+      def create_scaffold
+        if options.empty?
+          # TODO: ....
+        end
+        create_model unless options[:no_model]
+        create_route unless options[:no_route]
+        create_controller unless options[:no_controller]
+        create_list_view
+      end
+
+      private
+
+      # Create a dedicated controller,
+      # It does not have any relation to Faalis
+      # TODO: Check for better way
+      def create_controller
+        #invoke "scaffold_controller", resource_data["name"]
+        if options[:no_asset]
+          `rails g scaffold_controller #{resource_data["name"]} --skip`
+        else
+          `rails g scaffold_controller #{resource_data["name"]}`
+        end
+      end
+
+      # Create route of the scaffold in config/routes.rb
+      def create_route
+        route "resources :#{resource_data["name"].pluralize}"
+      end
+
+      #Create model of the scaffold with belongs_to support
+      #It does not support has_many relation yet
+      def create_model
+        result = []
+        all_fields = []
+        relations = "\n"
+        fields.each do |name, type, to|
+
+          case type
+          when 'belongs_to'
+            type_ = 'integer'
+            if to.singularize != name
+              relations << "belongs_to :#{name.singularize},
+              :class_name => \"#{to.singularize.capitalize}\"\n"
+            else
+              relations << "belongs_to :#{to.singularize}\n"
+            end
+            name_ = "#{name.singularize}_id"
+            result << [name_, type_]
+
+          when 'text', 'integer', 'string', 'boolean', 'datetime'
+            result << [name, type]
+
+          when 'image'
+            generate "paperclicp #{resource_data['name']} #{name}"
+            relations << "has_attached_file :#{name}\n"
+            relations << "validates_attachment_content_type :image, :content_type => %w(image/jpeg image/jpg image/png),:less_than => 1.megabytes]\n"
+          when 'tag'
+            rake "rake acts_as_taggable_on_engine:install:migrations"
+            relations << "acts_as_taggable_on :#{name}\n"
+            result << [name, 'string']
+
+          when 'in'
+            result << [name, 'string']
+
+          when 'has_many'
+            relations << "has_and_belongs_to_many :#{to}\n"
+            say_status 'warn', "There is a many to many relation between #{resource_data['name']} to #{to}, You should create it manually in model files"
+
+          end
+
+          all_fields = result.collect do |x|
+            x.join(':')
+          end
+
+        end
+
+        if parent?
+          all_fields << ["#{resource_data["parents"]}_id", "integer"]
+        end
+
+        invoke('active_record:model', [resource_data['name'], *all_fields], {
+                 migration: !options[:no_migration], timestamps: true
+               })
+        if File.exist?("app/models/#{resource_data["name"]}.rb")
+          inject_into_file "app/models/#{resource_data["name"]}.rb", after: 'Base' do
+            relations
+          end
+        else
+          puts "Could not find file app/models/#{resource_data["name"]}"
+        end
+      end
+
+      #Invoke Faalis list view generator
+      def create_list_view
+        invoke 'faalis:js:list_view', [jsonfile]
+
+      end
+    end
+  end
+end