faalis 0.16.3 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d61d933dd4c3ddbee82cdea09bba326cc90cb4da
-  data.tar.gz: 199548898cd205d7144769fb3c052a6ae4f9783f
+  metadata.gz: 9807cff362df15212e7a19378f538630e0e31330
+  data.tar.gz: 37dec94839c443774bd2d51975eac9167fc01bf4
 SHA512:
-  metadata.gz: 2d93712db24e85593e8fd0cd909ac568eb4ae978bb2acf9265b27093c3e61e8a70f51f778624d938e7735f2552b10d25542f0a426a87073e322ca80836e8b95e
-  data.tar.gz: 9c737066654c5c2049facc4e20cedf0ab78134dbf0d3640f62b636634520e907e1bd395d72e3f2469754765f83005f85cac38ab8d1ac205abc6d381b4ffb3be5
+  metadata.gz: fa37de6cd8b841994610e12aebed1b751efd943e7a2035379c77cde818167952d0bb7706c3e84f0863bce0c3eb46e007507a2df4b3d73dca490f8e1b57f8cc94
+  data.tar.gz: 2ec9fd8f7f2577217e5911102bdb12043d5815bbbcda3e788c424be63a77aba57fbbe7d3481dfc186888b84a7a3a0cf736030ebba769d00df0fd1262480b6167

data/app/views/angularjs_templates/modules.html

@@ -2,7 +2,7 @@
 
   <li ng-click="controller.on_click('/')"><p><i class="fa fa-dashboard"></i> <span translate>Dashboard</span></p></li>
 
-  <li data-ng-repeat="module in controller.modules" if-user="user.can('read', module.model)">
+  <li data-ng-repeat="module in controller.modules">
     <p ng-click="controller.view_menu(module)"><i class="{{ module.icon }}"></i> <span translate>{{ module.title }}</span></p>
     <ul class="submenu slide"  ng-if="module.show_menu">
         <li ng-repeat="menu_item in module.menu_items" ng-click="controller.on_click(menu_item.url)"><span>{{ menu_item.title }}</span></li>

data/lib/faalis.rb

@@ -29,3 +29,5 @@ require "faalis/omniauth"
 require "faalis/active_record"
 require "faalis/i18n"
 require "faalis/plugins"
+require "faalis/generators/concerns"
+require "faalis/generators"

data/lib/faalis/generators.rb

@@ -0,0 +1 @@
+require "faalis/generators/dashboard_scaffold"

data/lib/faalis/generators/concerns.rb

@@ -0,0 +1,9 @@
+require "faalis/generators/concerns/menu"
+require "faalis/generators/concerns/dependency"
+require "faalis/generators/concerns/bulk"
+require "faalis/generators/concerns/required"
+require "faalis/generators/concerns/parent"
+require "faalis/generators/concerns/resource_fields"
+require "faalis/generators/concerns/resource_name"
+require "faalis/generators/concerns/angular"
+require "faalis/generators/concerns/tabs"

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

@@ -0,0 +1,31 @@
+module Faalis
+  module Generators
+    module Concerns
+      module Angular
+
+        def self.included(base)
+          # Path to js_scaffold target inside 'app/assets/javascripts/'
+          base.class_option :path, :type => :string, :default => "", :desc => "Path to js_scaffold target inside 'app/assets/javascripts/'"
+
+          # Path to js_scaffold target
+          base.class_option :raw_path, :type => :string, :default => "", :desc => "Path to js_scaffold target"
+        end
+
+        private
+
+
+        def angularjs_app_path
+          if options[:raw_path] != ""
+            options[:raw_path]
+          elsif options[:path] != ""
+            "app/assets/javascripts/#{options[:path]}/"
+          else
+            path = Faalis::Engine.dashboard_js_manifest.split("/")[0..-2].join("/")
+            "app/assets/javascripts/#{path}/"
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module Faalis
+  module Generators
+    module Concerns
+      module Bulk
+
+        def self.included(base)
+          # Fields to use in in bulk edit, comma separated
+          base.class_option :bulk_fields, :type => :string, :default => "", :desc => "Fields to use in in bulk edit, comma separated"
+
+          # No bulk edit needed
+          base.class_option :no_bulk, :type => :boolean, :default => false, :desc => "No bulk edit needed"
+        end
+
+        private
+
+        # Returns fields which is needed to be in bulk edit
+        def bulk_edit_fields
+          unless options[:bulk_fields].empty?
+            bfields = options[:bulk_fields].split(",")
+            fields_ = fields_hash
+            bfields.each do |f|
+              unless fields_.include? f
+                raise ::Exception.new "'#{f}' is not in scaffold fields."
+              end
+            end
+            return bfields
+          else
+
+            return self.send(:fields).collect {|f| f[0]}
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module Faalis
+  module Generators
+    module Concerns
+      module Dependency
+
+        def self.included(base)
+          # Dependencies of Angularjs module, comma separated
+          base.class_option :deps, :type => :string, :default => "", :desc => "Dependencies of Angularjs module, comma separated"
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module Faalis
+  module Generators
+    module Concerns
+      module Menu
+
+        def self.included(base)
+          # Provide menu items which should be in sidebar. format: menu1:url,menu2:url
+          base.class_option :menu, :type => :string, :default => "", :desc => "Provide menu items which should be in sidebar. format: menu1:url,menu2:url"
+        end
+
+        private
+
+        def parse_menu(menu)
+          regex = /([^:{}]+){1}\:([^:\{\}]+)(?:{(.*)})?/i
+          model = nil
+          if menu =~ regex
+            title = $1
+            url = $2
+            model = $3
+            return title, url, model
+          else
+            Raise Exception.new "Menu items format should be like 'name:url{model}'. Model part is optional"
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Faalis
+  module Generators
+    module Concerns
+      module Parent
+
+        def self.included(base)
+          # Specify the parent resource if there was any
+          base.class_option :parent, :type => :string, :default => "", :desc => "Specify the parent resource if there was any"
+        end
+
+        private
+
+        # check for parent
+        def parent?
+          if options[:parent] != ""
+            return true
+          end
+          false
+        end
+
+        # Remove the starting slash from the given parent path
+        def trim_parent_path
+          if parent?
+            options[:parent].gsub(/^\//, "")
+          else
+            ""
+          end
+        end
+
+        # -------------------------
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module Faalis
+  module Generators
+    module Concerns
+      module RequireFields
+
+        def self.included(base)
+          # Non optional fields, comma separated
+          base.class_option :required, :type => :string, :default => "", :desc => "Non optional fields, comma separated"
+        end
+
+        private
+
+        def required_fields
+          if not options[:required].empty?
+            return options[:required].split(",")
+          end
+          []
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+require "faalis/generators/fields/relation"
+
+
+module Faalis
+  module Generators
+    module Concerns
+      module ResourceFields
+
+        def self.included(base)
+          # An array of resource fields. fields should be separated by space
+          # each filed should be in this format `field_name:field_type[:extra_info]
+          base.argument :resource_fields, type: :array, default: [], banner: "fields[:types]"
+
+        end
+
+        private
+        # An array of fields like
+        # [name, type]
+        def fields
+          fields = []
+          resource_fields.each do |field|
+            name, type, to = field.split(":")
+            if ["belongs_to", "has_many", "in"].include? type
+              type = Relation.new(type, to)
+            end
+
+            fields << [name, type]
+          end
+          fields
+        end
+
+        def fields_hash
+          Hash[fields]
+        end
+
+        def grid_fields
+          fields
+        end
+
+        # Return an string to use as a function parameters each
+        # field appears as symbol
+        def fields_as_params(relations: false)
+          result = ""
+          field_num = 0
+          fields.each do |name, type|
+            if relations
+              if ["belongs_to"].include? type
+                result += " :#{name}_id"
+              else
+                result += " :#{name}"
+              end
+              field_num += 1
+              if field_num < fields.length
+                result += ","
+              end
+
+            else
+              unless ["belongs_to", "has_many"].include? type
+                result += " :#{name}"
+                field_num += 1
+                if field_num < fields.length
+                  result += ","
+                end
+              end
+            end
+
+          end
+
+          if result
+            result = ",#{result}"
+            if result[-1] == ","
+              result = result[0..-2]
+            end
+          end
+
+          result
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+module Faalis
+  module Generators
+    module Concerns
+      module ResourceName
+
+        def self.included(base)
+          # Name of the resource to create.
+          base.argument :resource_name, :type => :string, :required => true
+        end
+
+        private
+
+        # Path to the resource
+        def resource_path
+          path_parts = resource_name.split("/")
+          if path_parts.length > 1
+            return "#{path_parts(0..-2).join("/")}/#{path_parts[-1].underscore}"
+          end
+          resource_name.underscore
+        end
+
+        # Url of resource
+        def resource_url
+          path_parts = resource_name.split("/")
+          if path_parts.length > 1
+            return "#{path_parts(0..-2).join("/")}/#{path_parts[-1].pluralize.underscore}"
+          end
+          resource_name.pluralize.underscore
+        end
+
+        def resource
+          path_parts = resource_name.split("/")
+          if path_parts.length > 1
+            return path_parts[-1].camelize
+          end
+          resource_name.camelize
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Faalis
+  module Generators
+    module Concerns
+      module Tabs
+
+        def self.included(base)
+          # Add tabs to 'new' view of scaffold. format: --tabs tab1:'field1;field2',tab2 Note: __all__ field include all fileds.
+          base.class_option :tabs, :type => :string, :default => "", :desc => "Add tabs to 'new' view of scaffold. format: --tabs tab1:'field1;field2',tab2 Note: __all__ field include all fileds."
+        end
+
+        private
+
+        # Process the user provided tabs
+        # @return a Hash of tabs like
+        def tabs
+          if options[:tabs].present?
+            tabs = options[:tabs].split(",")
+            result = {}
+            tabs.each do |tab|
+              name, fields = tab.split(":")
+              fields_list = []
+              unless fields.nil?
+                fields_list = fields.split(";")
+              end
+              result[name] = fields_list
+            end
+            return result
+          else
+            {}
+          end
+        end
+
+        def any_tabs?
+          options[:tabs].present?
+        end
+
+      end
+    end
+  end
+end

data/lib/faalis/generators/dashboard_scaffold.rb

@@ -0,0 +1,35 @@
+module Faalis
+  module Generators
+    # `DashboardScaffold` is the base class for all the dashboard
+    # scaffolds which make creating scaffold generators way more
+    # easier. But you can drive your own generator normally of caurse
+    class DashboardScaffold < Rails::Generators::Base
+
+      include ActionView::Helpers::TextHelper
+      include Faalis::Generators::Concerns::ResourceName
+      include Faalis::Generators::Concerns::ResourceFields
+      include Faalis::Generators::Concerns::Menu
+      include Faalis::Generators::Concerns::Dependency
+      include Faalis::Generators::Concerns::Bulk
+      include Faalis::Generators::Concerns::RequireFields
+      include Faalis::Generators::Concerns::Parent
+      include Faalis::Generators::Concerns::Angular
+      include Faalis::Generators::Concerns::Tabs
+
+
+      # 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"
+
+      # 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"
+
+
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module Faalis
+  module Generators
+    class Relation < String
+      attr_accessor :to
+
+      def initialize(value, to_)
+        super(value)
+        self.to = to_
+      end
+
+      def resource_name
+        to.split("/").last
+      end
+
+      def restangular
+        result = "API"
+        to.split("/").each do |resource|
+          result = "#{result}.all(\"#{resource}\")"
+        end
+        result
+      end
+
+      def get_list
+        "#{restangular}.getList()"
+      end
+    end
+  end
+end