faalis 1.0.0.alpha0 → 1.0.0.alpha1

data/config/routes.rb

@@ -3,8 +3,9 @@ Faalis::Engine.routes.draw do
 
   # Authentications
   devise_config = {
-    :class_name => 'Faalis::User',
-    :module => :devise
+    class_name: 'Faalis::User',
+    :module =>  :devise,
+    skip: :omniauth_callbacks
   }
 
   # Add omniauth callback if there was any provider
@@ -14,7 +15,6 @@ Faalis::Engine.routes.draw do
     }
   end
 
-  devise_for :users, devise_config
 
 
   scope '(:locale)', :locale => Regexp.new(::I18n.available_locales.join('|')) do
@@ -23,10 +23,23 @@ Faalis::Engine.routes.draw do
       get 'modules' => 'dashboard#modules'
     end
 
+    devise_for :users, devise_config
+
 
     # Root URL
     root :to => 'home#index'
   end
 
+  match('/users/auth/:provider',
+        constraints: { provider: /#{Devise.omniauth_configs.keys.join("|")}/ },
+        to: "devise/omniauth_callbacks#passthru",
+        as: :user_omniauth_authorize,
+        via: [:get, :post])
+
+  match('/users/auth/:action/callback',
+        constraints: { action: /#{Devise.omniauth_configs.keys.join("|")}/ },
+        to: 'devise/omniauth_callbacks',
+        as: :user_omniauth_callback,
+        via: [:get, :post])
 
 end

data/lib/faalis.rb

@@ -23,6 +23,7 @@ require 'devise'
 module Faalis
 end
 
+require 'faalis/middlewares'
 require 'faalis/engine'
 require 'faalis/orm'
 require 'faalis/concerns'

data/lib/faalis/discovery/permissions.rb

@@ -1,8 +1,10 @@
 module Faalis
   module Discovery
+    # This class is responsible to discoering all Permissions
+    # classes and provide a list of available permissions
     class Permissions
 
-      # Run the given block fir each object with permissions
+      # Run the given block for each object with permissions
       def self.permission_objects(&block)
         objects = []
 
@@ -12,6 +14,9 @@ module Faalis
         # model it has the permission_strings). And concat the
         # permissions to `@permissions` instance method.
         ::ApplicationModels.to_adapter.find_all.each do |m|
+          # `m` is a string contains name of a model and
+          # we use contstantize to get the model class with
+          # such name
           model = m.model.constantize
           if model.respond_to? :permission_strings
             block.call(model)
@@ -37,12 +42,14 @@ module Faalis
         permissions.uniq
       end
 
+      # Creating all possible permissions in database using
+      # `Faalis::Permission` model
       def self.create_all_permissions
 
         permission_objects do |object|
           object.possible_permissions.each do |perm|
-            Faalis::Permission.create(model: object.to_s,
-                                      permission_type: perm)
+            Faalis::Permission.where(model: object.to_s,
+                                     permission_type: perm).first_or_create
           end
         end
       end

data/lib/faalis/engine.rb

@@ -25,6 +25,11 @@ require 'model_discovery'
 require 'angularjs-rails'
 require 'lodash-rails'
 
+# required gettext related gem only in developement
+if Rails.env.development?
+  require 'gettext_i18n_rails'
+end
+
 module Faalis
   # `Engine` class of **Faalis**.
   class Engine < ::Rails::Engine
@@ -140,5 +145,21 @@ module Faalis
     mattr_accessor :dashboard_js_manifest
     @@dashboard_js_manifest = "controlpanel/application.js"
 
+    # Devise options
+    # Include default devise modules. Others available are:
+    # :token_authenticatable, :confirmable,
+    # :lockable, :timeoutable and :omniauthable
+    mattr_accessor :devise_options
+    @@devise_options = [:database_authenticatable,
+                        :registerable,
+                        :recoverable,
+                        :rememberable,
+                        :trackable,
+                        :lockable,
+                        :timeoutable,
+                        :validatable]
+
+    middleware.use Faalis::Middlewares::Locale
+
   end
 end

data/lib/faalis/generators/concerns.rb

@@ -3,6 +3,7 @@ require 'faalis/generators/concerns/dependency'
 require 'faalis/generators/concerns/bulk'
 require 'faalis/generators/concerns/required'
 require 'faalis/generators/concerns/parent'
+require 'faalis/generators/concerns/child'
 require 'faalis/generators/concerns/resource_fields'
 require 'faalis/generators/concerns/resource_name'
 require 'faalis/generators/concerns/angular'
@@ -13,3 +14,4 @@ require 'faalis/generators/concerns/allow_query_on'
 require 'faalis/generators/concerns/render'
 require 'faalis/generators/concerns/where'
 require 'faalis/generators/concerns/fieldset'
+require 'faalis/generators/concerns/globalize'

data/lib/faalis/generators/concerns/allow_query_on.rb

@@ -7,16 +7,15 @@ module Faalis
 
         private
 
-
         def allowed_fields
           if allowed_fields_provided?
-            unless resource_data["allow_query_on"].is_a? Array
-              raise Exception.new "value of `allow_query_on` key should be an Array. "
-            end
-            fields = resource_data["allow_query_on"].collect do |f|
-              ":#{f}"
+            unless resource_data['allow_query_on'].is_a? Array
+              fail Exception.new 'value of `allow_query_on` key should be an Array. '
             end
-            fields.join(" ,")
+            # :#{something} is a trick to convert the field name to sym on
+            # controller
+            fields = resource_data['allow_query_on'].collect { |f| ":#{f}" }
+            fields.join(' ,')
           else
             []
           end
@@ -24,14 +23,11 @@ module Faalis
 
         # Check for any allowed fields in json
         def allowed_fields_provided?
-          if resource_data.include? "allow_query_on"
-            unless resource_data["allow_query_on"].nil?
-              return true
-            end
+          if resource_data.include? 'allow_query_on'
+            return true unless resource_data['allow_query_on'].nil?
           end
           false
         end
-
       end
     end
   end

data/lib/faalis/generators/concerns/angular.rb

@@ -13,16 +13,15 @@ module Faalis
 
         # return the relative path to place where scaffold shoud be created.
         def angularjs_app_path
-          if not resource_data["raw_path"].blank?
-            resource_data["raw_path"]
-          elsif not resource_data["path"].blank?
+          if  !resource_data['raw_path'].blank?
+            resource_data['raw_path']
+          elsif !resource_data['path'].blank?
             "app/assets/javascripts/#{resource_data['path']}/"
           else
-            path = Faalis::Engine.dashboard_js_manifest.split("/")[0..-2].join("/")
+            path = Faalis::Engine.dashboard_js_manifest.split('/')[0..-2].join('/')
             "app/assets/javascripts/#{path}/"
           end
         end
-
       end
     end
   end

data/lib/faalis/generators/concerns/child.rb

@@ -0,0 +1,31 @@
+module Faalis
+  module Generators
+    module Concerns
+
+      module Child
+
+        private
+
+        # check for child
+        def child?
+          if resource_data.include? 'childs'
+            return true unless resource_data['childs'].nil?
+          end
+          false
+        end
+
+
+        # Return an array of resource childs
+        def childs
+          if child?
+            resource_data['childs']
+          else
+            []
+          end
+        end
+
+
+      end
+    end
+  end
+end

data/lib/faalis/generators/concerns/fieldset.rb

@@ -10,11 +10,11 @@ module Faalis
 
         # Returns fields which is needed to be in bulk edit
         def fieldset?
-          !fields_with_attribute("fieldset").empty?
+          !fields_with_attribute('fieldset').empty?
         end
 
         def fieldset_less_fields
-          fields = Set.new(raw_fields_data) - Set.new(fields_with_attribute("fieldset"))
+          fields = Set.new(raw_fields_data) - Set.new(fields_with_attribute('fieldset'))
           fields.to_a
         end
 

data/lib/faalis/generators/concerns/globalize.rb

@@ -0,0 +1,14 @@
+module Faalis
+  module Generators
+    module Concerns
+      module Globalize
+        private
+
+        def globalize_fields
+          fields_with("globalize", true)
+        end
+
+      end
+    end
+  end
+end

data/lib/faalis/generators/concerns/hstore.rb

@@ -0,0 +1,19 @@
+module Faalis
+  module Generators
+    module Concerns
+      # This concern adds support for `PostgreSQL` Hstore
+      # type to generators. So `hstore` fields will not work
+      # on other databases or work differently. For example
+      # We try to create a json from the key/values of `hstore`
+      # field and store that to the corresponding field.
+      module Hstore
+
+        private
+
+        def hstore_fields
+          fields_with('type', 'hstore')
+        end
+      end
+    end
+  end
+end

data/lib/faalis/generators/concerns/model.rb

@@ -10,15 +10,15 @@ module Faalis
 
         # Does an alternative `model` is specified ?
         def model_specified?
-          resource_data.include? "model"
+          resource_data.include? 'model'
         end
 
         # Name of alternative `model`
         def model
           if model_specified?
-            resource_data["model"]
+            resource_data['model']
           else
-            ""
+            ''
           end
         end
 

data/lib/faalis/generators/concerns/parent.rb

@@ -33,23 +33,21 @@ module Faalis
 
         # check for parent
         def parent?
-          if resource_data.include? "parents"
-            unless resource_data["parents"].nil?
-              return true
-            end
+          if resource_data.include? 'parents'
+            return true unless resource_data['parents'].nil?
           end
           false
         end
 
         # Remove the starting slash from the given parent path
         def trim_parent_path(path)
-          path.gsub(/^\//, "")
+          path.gsub(/^\//, '')
         end
 
         # Return an array of resource parents
         def parents
           if parent?
-            _parents = resource_data["parents"]
+            _parents = resource_data['parents']
             _parents.collect do |p|
               trim_parent_path(p)
             end

data/lib/faalis/generators/concerns/required.rb

@@ -9,7 +9,8 @@ module Faalis
         private
 
         def required_fields
-          fields_with("required", true).collect {|x| x["name"]}
+          # Returnes an array contains name of all fields with require = true
+          fields_with('required', true).collect {|x| x['name']}
         end
       end
     end

data/lib/faalis/generators/concerns/resource_name.rb

@@ -24,6 +24,7 @@ module Faalis
           resource_data["name"].pluralize.underscore
         end
 
+        # Camelized resource name. you can think of it as model name
         def resource
           path_parts = resource_data["name"].split("/")
           if path_parts.length > 1

data/lib/faalis/generators/concerns/tabs.rb

@@ -22,10 +22,10 @@ module Faalis
             result = {}
             tabs.each do |tab|
               name = tab['name']
+
               fields_list = fields_with('tab', tab['id'])
-              fields_list.each do |f|
-                tabbed_fields << f
-              end
+              fields_list.each { |f| tabbed_fields << f }
+
               result[name] = fields_list
             end
             all_fields = Set.new resource_data['fields']
@@ -43,16 +43,13 @@ module Faalis
         end
 
         def tab_has_field?(tab_name, field_name)
-          it_does = tabs[tab_name].select do |f|
-            f['name'] == field_name
-          end
+          it_does = tabs[tab_name].select { |f| f['name'] == field_name }
           !it_does.empty?
         end
 
         def any_tabs?
           resource_data.include? 'tabs'
         end
-
       end
     end
   end

data/lib/faalis/generators/concerns/where.rb

@@ -4,7 +4,7 @@ module Faalis
 
       # This module is dedicated to filter resource object based
       # on a condition or query. For example if you want to filter
-      # resource objects to those which belongs to current logged
+      # a resource objects to those which belongs to current logged
       # in user you can do like:
       #
       # ```javascript
@@ -38,8 +38,6 @@ module Faalis
           end
           {}
         end
-
-
       end
     end
   end

data/lib/faalis/generators/dashboard_scaffold.rb

@@ -14,6 +14,7 @@ module Faalis
       include Faalis::Generators::Concerns::Bulk
       include Faalis::Generators::Concerns::RequireFields
       include Faalis::Generators::Concerns::Parent
+      include Faalis::Generators::Concerns::Child
       include Faalis::Generators::Concerns::Angular
       include Faalis::Generators::Concerns::Tabs
       include Faalis::Generators::Concerns::Model
@@ -28,6 +29,7 @@ module Faalis
       # Generate only spec files
       class_option :only_specs, type: :boolean, default: false, desc: 'Generate only spec files'
 
+      # TODO: Move it to listview generator
       # Generate only controller
       class_option :only_controller, type: :boolean, default: false, desc: 'Generate only controller'
 

data/lib/faalis/generators/fields/#relation.rb#

@@ -0,0 +1,61 @@
+module Faalis
+  module Generators
+    class Relation < String
+      attr_accessor :to
+
+      def initialize(value, to, options = "")
+        super(value)
+        @options = options
+        @to = to
+      end
+
+      def resource_name
+        to.split("/").last
+      end
+
+      def to
+        result = "'"
+        if options.include? "parents"
+          field_parents.each do |parent|
+            result = "#{result}/#{parent}/' + $scope.#{parent}_id + '"
+          end
+          result = "#{result}/"
+        end
+        "#{result}#{@to}'"
+      end
+
+      def options
+        unless @options.empty?
+          Hash[@options.split(',').map {|pair| pair.strip.split(':').map(&:strip) }]
+        else
+          {}
+        end
+      end
+
+      def field_parents
+        if options.include? "parents"
+          options["parents"].split(";")
+        else
+          []
+        end
+      end
+
+      def restangular
+        result = "API"
+        if options.include? "parents"
+          field_parents.each do |parent|
+            result = "#{result}.one('#{parent}', #{}_id)"
+          end
+        end
+        to.split("/").each do |resource|
+          result = "#{result}.all(\"#{resource}\")"
+        end
+        result
+      end
+
+      def get_list
+        "#{restangular}.getList()"
+      end
+    end
+  end
+end