faalis 0.16.3 → 0.17.0

data/lib/faalis/version.rb

@@ -18,5 +18,5 @@
 # -----------------------------------------------------------------------------
 
 module Faalis
-  VERSION = "0.16.3"
+  VERSION = "0.17.0"
 end

data/lib/generators/faalis/js/list_view_generator.rb

@@ -0,0 +1,110 @@
+# -----------------------------------------------------------------------------
+#    Faalis - Basic website skel engine
+#    Copyright (C) 2012-2013 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
+    module Js
+      # `faalis:js:list_view` scaffold generator class
+      class ListViewGenerator < Faalis::Generators::DashboardScaffold
+
+        # templates path
+        source_root File.expand_path('../../templates', __FILE__)
+
+        # Field name to use as title of each object
+        class_option :title_field, :type => :string, :default => "name", :desc => "Field name to use as title of each object"
+
+        # Don't copy the new.html template
+        class_option :no_new_template, :type => :boolean, :default => false, :desc => "Don't copy the new.html template"
+
+        desc "Create a new resource for client side application"
+        def create_module
+          unless options[:only_controller]
+            unless options[:only_specs]
+              template "js/list_view/module.js.erb", "#{angularjs_app_path}modules/#{resource_path}.js"
+            end
+          end
+        end
+
+        def create_template
+          unless options[:only_controller]
+            unless options[:only_specs]
+              template "js/list_view/index.html.erb", "app/views/angularjs_templates/#{resource.underscore}/index.html"
+              unless options[:no_new_template]
+                template "js/list_view/new.html.erb", "app/views/angularjs_templates/#{resource.underscore}/new.html"
+              end
+              template "js/list_view/details.html.erb", "app/views/angularjs_templates/#{resource.underscore}/details.html"
+            end
+          end
+
+          unless options[:only_specs]
+            template "views/index.json.jbuilder.erb", "app/views/api/v1/#{resource.pluralize.underscore}/index.json.jbuilder"
+            template "views/show.json.jbuilder.erb", "app/views/api/v1/#{resource.pluralize.underscore}/show.json.jbuilder"
+            template "views/create.json.jbuilder.erb", "app/views/api/v1/#{resource.pluralize.underscore}/create.json.jbuilder"
+            template "views/destroy.json.jbuilder.erb", "app/views/api/v1/#{resource.pluralize.underscore}/destroy.json.jbuilder"
+            template "views/update.json.jbuilder.erb", "app/views/api/v1/#{resource.pluralize.underscore}/update.json.jbuilder"
+          end
+        end
+
+        def create_api
+          unless options[:only_specs]
+            template "api/controller.rb.erb", "app/controllers/api/v1/#{resource.pluralize.underscore}_controller.rb"
+          end
+        end
+
+        def create_specs
+          unless options[:without_specs]
+            template "features/api.feature", "features/#{resource.underscore}.api.feature"
+            template "features/api.step.rb", "features/step_definitions/#{resource.underscore}.rb"
+          end
+        end
+
+        def show_readme
+          readme "js/list_view/README" if behavior == :invoke
+        end
+
+        # PRIVATES --------------------------------------------
+        private
+
+        def is_in_engine?
+          false
+        end
+
+        def random_json_data
+          data = {}
+          fields.each do |field, type|
+            case type
+            when "belongs_to"
+              data["#{field}_id"] = 1
+            when "integer"
+              data[field] = 1+ rand(1000)
+            else
+              data[field] = random_string
+            end
+          end
+          data.to_json.to_s
+        end
+
+        def random_string
+          o = [('a'..'z'), ('A'..'Z')].map { |i| i.to_a }.flatten
+          (0...50).map{ o[rand(o.length)] }.join
+        end
+      end
+    end
+  end
+end

data/lib/generators/faalis/js_scaffold_generator.rb

@@ -20,65 +20,21 @@
 module Faalis
   module Generators
     # `js_scaffold` main class
-    class JsScaffoldGenerator < Rails::Generators::Base
+    class JsScaffoldGenerator < Faalis::Generators::DashboardScaffold
+      # We keep this class to keep backward compatiblity
+      puts "[DEPRECATED]: This generator will be removed soon, Use faalis:js:list_view instead."
+      # TODO: Remove this ater a while
 
-      include ActionView::Helpers::TextHelper
 
       # templates path
       source_root File.expand_path('../templates', __FILE__)
 
-      # Name of the resource to create.
-      argument :resource_name, :type => :string, :required => true
-
-      # An array of resource fields. fields should be separated by space
-      # each filed should be in this format `field_name:field_type[:extra_info]
-      argument :resource_fields, type: :array, default: [], banner: "fields[:types]"
-
-      # 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"
-
-      # Fields to use in in bulk edit, comma separated
-      class_option :bulk_fields, :type => :string, :default => "", :desc => "Fields to use in in bulk edit, comma separated"
-
-      # No bulk edit needed
-      class_option :no_bulk, :type => :boolean, :default => false, :desc => "No bulk edit needed"
-
-      # Provide menu items which should be in sidebar. format: menu1:url,menu2:url
-      class_option :menu, :type => :string, :default => "", :desc => "Provide menu items which should be in sidebar. format: menu1:url,menu2:url"
-
       # Field name to use as title of each object
       class_option :title_field, :type => :string, :default => "name", :desc => "Field name to use as title of each object"
 
-      # Non optional fields, comma separated
-      class_option :required, :type => :string, :default => "", :desc => "Non optional fields, comma separated"
-
-      # Dependencies of Angularjs module, comma separated
-      class_option :deps, :type => :string, :default => "", :desc => "Dependencies of Angularjs module, comma separated"
-
-      # Path to js_scaffold target inside 'app/assets/javascripts/'
-      class_option :path, :type => :string, :default => "", :desc => "Path to js_scaffold target inside 'app/assets/javascripts/'"
-
-      # Path to js_scaffold target
-      class_option :raw_path, :type => :string, :default => "", :desc => "Path to js_scaffold target"
-
-      # Add tabs to 'new' view of scaffold. format: --tabs tab1:'field1;field2',tab2 Note: __all__ field include all fileds.
-      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."
-
-      # Don't show a filter box
-      class_option :no_filter, :type => :boolean, :default => false, :desc => "Don't view a filter box"
-
       # Don't copy the new.html template
       class_option :no_new_template, :type => :boolean, :default => false, :desc => "Don't copy the new.html template"
 
-      # Specify the parent resource if there was any
-      class_option :parent, :type => :string, :default => "", :desc => "Specify the parent resource if there was any"
-
       desc "Create a new resource for client side application"
       def create_module
         unless options[:only_controller]
@@ -128,183 +84,10 @@ module Faalis
       # PRIVATES --------------------------------------------
       private
 
-      # Resource parent related ----------------------
-      # 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
-
-      # -------------------------
-
-      # 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
-
       def is_in_engine?
         false
       end
 
-      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
-
-      # Tabs ------------------------------------
-
-      # 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
-      # -----------------------------------
-
-      # 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
-
-      # 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
-
-      # 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
-
-      def parse_menu(menu)
-        title, url = menu.split(":")
-        model = nil
-        if title.split(">").length > 1
-          title, model = title.split(">")
-        end
-        return title, url, model
-      end
-
-
       def random_json_data
         data = {}
         fields.each do |field, type|
@@ -325,36 +108,6 @@ module Faalis
         (0...50).map{ o[rand(o.length)] }.join
       end
 
-      def required_fields
-        if not options[:required].empty?
-          return options[:required].split(",")
-        end
-        []
-      end
-      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
 end

data/lib/generators/faalis/templates/angularjs/module.js.erb

@@ -20,7 +20,7 @@
 
 <% end %>
 // <%= resource.pluralize %> Module
-var <%= resource.pluralize %> = angular.module("<%= resource %>", ["ListView", "Filter", "Anim", "Fields",<% if options[:deps] %><% options[:deps].split(",").each do |dependency| %>, "<%= dependency.camelize %>"<% end %><% end %>]);
+var <%= resource.pluralize %> = angular.module("<%= resource %>", ["ListView", "Filter", "Anim", "Fields",<% if options[:deps] %><% options[:deps].gsub(" ", "").split(",").each do |dependency| %> "<%= dependency.camelize %>", <% end %><% end %>]);
 
 // <%= resource.pluralize %> configuration section ---------------------------
 <%= resource.pluralize %>.config(["$routeProvider", function($routeProvider){

data/lib/generators/faalis/templates/js/list_view/README

@@ -0,0 +1,31 @@
+==================================================
+Steps to installation:
+
+      0. You have to have a working model to use this scaffold. So create
+         your model and setup validations, relations and other stuff.
+
+      1. Add resource to routes.rb for example in case of `car` scaffold do:
+
+           namespace :api, :defaults => {:format => :json} do
+             namespace :v1 do
+               resources :cars
+             end
+           end
+
+      2. The Angularjs module of your resource should be added as an dependency
+         to another Angularjs module. Add it by hand or if you want to view module
+         in dashboard's main page add your resource to `config/initializers/faalis.rb`
+         like this:
+
+                config.dashboard_modules = {
+                    :car => {
+                       :icon => "fa fa-car",
+                       :sidemenu => true,
+                    },
+                }
+
+      3. Make sure that you have `api_controller.rb` in your `app/controllers` with this content:
+
+
+              class APIController < Faalis::APIController
+              end