faalis 0.7.0

data/lib/generators/faalis/USAGE

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

data/lib/generators/faalis/angularjs_resource_generator.rb

@@ -0,0 +1,74 @@
+# -----------------------------------------------------------------------------
+#    Red Base - 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
+    class AngularjsResourceGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :resource_name, :type => :string, :required => true
+      argument :dependencies, type: :array, default: [], banner: "dependencies"
+
+      desc "Create a new resource for angularjs application"
+      def create_module
+        template "angularjs/module.js.erb", "#{angularjs_app_path}modules/#{resource_path}.js"
+      end
+
+      def create_template
+        template "angularjs/index.html.erb", "app/assets/templates/#{resource.underscore}/index.html"
+      end
+
+      private
+
+      def get_dependencies
+        deps = []
+        dependencies.each do |dependency|
+          deps << "'#{dependency.camelize}'"
+        end
+
+        deps.join(", ")
+      end
+
+      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
+
+      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
+        path = Faalis::Engine.dashboard_js_manifest.split("/")[0..-2].join("/")
+        "app/assets/javascripts/#{path}/"
+      end
+    end
+  end
+end

data/lib/generators/faalis/install_all_generator.rb

@@ -0,0 +1,38 @@
+# -----------------------------------------------------------------------------
+#    Red Base - 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
+    class InstallAllGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Copy all the necessary files to use Red Base (migrations included)"
+      hook_for :install_generator
+
+      def copy_migrations
+        rake("faalis:install:migrations")
+      end
+
+      def copy_install
+        invoke "faalis:install"
+      end
+
+    end
+  end
+end

data/lib/generators/faalis/install_generator.rb

@@ -0,0 +1,42 @@
+# -----------------------------------------------------------------------------
+#    Red Base - 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
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Copy all the necessary files to use Red Base"
+      class_option :orm
+
+      def copy_init_files
+        template "devise.rb", "config/initializers/devise.rb"
+        template "faalis.rb", "config/initializers/faalis.rb"
+        template "fast_gettext.rb", "config/initializers/fast_gettext.rb"
+        template "formtastic.rb", "config/initializers/formstatic.rb"
+        template "seeds.rb", "db/seeds.rb"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+
+    end
+  end
+end

data/lib/generators/faalis/install_specs_generator.rb

@@ -0,0 +1,48 @@
+# -----------------------------------------------------------------------------
+#    Red Base - 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
+    class InstallSpecsGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Copy all the necessary files to install and use specs"
+
+      def install_gems
+        invoke "rspec:install"
+        invoke "cucumber:install", ["--capybara", "--rspec"]
+      end
+
+      def update_configurations
+        copy_file "features/step_definitions/email_steps.rb", "features/step_definitions/email_steps.rb"
+        copy_file "features/support/env.rb", "features/support/env.rb"
+        copy_file "spec/factories/groups.rb", "spec/factories/groups.rb"
+        copy_file "spec/factories/users.rb", "spec/factories/users.rb"
+        copy_file "spec/spec_helper.rb", "spec/spec_helper.rb"
+        copy_file "spec/support/devise.rb", "spec/support/devise.rb"
+      end
+
+      def show_readme
+        readme "SPECS" if behavior == :invoke
+      end
+
+
+    end
+  end
+end

data/lib/generators/faalis/js_scaffold_generator.rb

@@ -0,0 +1,273 @@
+# -----------------------------------------------------------------------------
+#    Red Base - 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
+    class JsScaffoldGenerator < Rails::Generators::Base
+
+      include ActionView::Helpers::TextHelper
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :resource_name, :type => :string, :required => true
+      argument :resource_fields, type: :array, default: [], banner: "fields[:types]"
+      class_option :without_specs, :type => :boolean, :default => false, :desc => "Do not install specs"
+      class_option :only_specs, :type => :boolean, :default => false, :desc => "Generate only spec files"
+      class_option :bulk_fields, :type => :string, :default => "", :desc => "Fields to use in in bulk edit, comma separated"
+      class_option :no_bulk, :type => :boolean, :default => false, :desc => "No bulk edit needed"
+      class_option :menu, :type => :string, :default => "", :desc => "Provide menu items which should be in sidebar. format: menu1:url,menu2:url"
+      class_option :title_field, :type => :string, :default => "name", :desc => "Field name to use as title of each object"
+      class_option :required, :type => :string, :default => "", :desc => "Non optional fields, comma separated"
+      class_option :deps, :type => :string, :default => "", :desc => "Dependencies of Angularjs module, comma separated"
+      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."
+      class_option :no_filter, :type => :boolean, :default => false, :desc => "Don't view a filter box"
+
+      desc "Create a new resource for client side application"
+      def create_module
+        unless options[:only_specs]
+          template "angularjs/module.js.erb", "#{angularjs_app_path}modules/#{resource_path}.js"
+        end
+      end
+
+      def create_template
+        unless options[:only_specs]
+          template "angularjs/index.html.erb", "app/views/angularjs_templates/#{resource.underscore}/index.html"
+          template "angularjs/new.html.erb", "app/views/angularjs_templates/#{resource.underscore}/new.html"
+          template "angularjs/details.html.erb", "app/views/angularjs_templates/#{resource.underscore}/details.html"
+
+          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_scaffold.README" if behavior == :invoke
+      end
+
+      # PRIVATES --------------------------------------------
+      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
+
+      def is_in_engine?
+        false
+      end
+
+      def angularjs_app_path
+        path = Faalis::Engine.dashboard_js_manifest.split("/")[0..-2].join("/")
+        "app/assets/javascripts/#{path}/"
+      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 fields.keys
+        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 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
+
+      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