wallaby 5.0.1 → 5.1.3

data/app/views/wallaby/resources/show/_tsrange.html.erb

@@ -1,3 +1,7 @@
+<%# @param object [model] model instance %>
+<%# @param field_name [String] name of the field %>
+<%# @param value [Object] value of the field %>
+<%# @param metadata [Hash] metadata of the field %>
 <% if value.nil? %>
   <%= null %>
 <% else %>

data/app/views/wallaby/resources/show/_tstzrange.html.erb

@@ -1,3 +1,7 @@
+<%# @param object [model] model instance %>
+<%# @param field_name [String] name of the field %>
+<%# @param value [Object] value of the field %>
+<%# @param metadata [Hash] metadata of the field %>
 <% if value.nil? %>
   <%= null %>
 <% else %>

data/app/views/wallaby/resources/show/_tsvector.html.erb

@@ -1 +1,5 @@
+<%# @param object [model] model instance %>
+<%# @param field_name [String] name of the field %>
+<%# @param value [Object] value of the field %>
+<%# @param metadata [Hash] metadata of the field %>
 <%= value || null %>

data/app/views/wallaby/resources/show/_unsigned_bigint.html.erb

@@ -0,0 +1,5 @@
+<%# @param object [model] model instance %>
+<%# @param field_name [String] name of the field %>
+<%# @param value [Object] value of the field %>
+<%# @param metadata [Hash] metadata of the field %>
+<%= value || null %>

data/app/views/wallaby/resources/show/_unsigned_decimal.html.erb

@@ -0,0 +1,5 @@
+<%# @param object [model] model instance %>
+<%# @param field_name [String] name of the field %>
+<%# @param value [Object] value of the field %>
+<%# @param metadata [Hash] metadata of the field %>
+<%= value || null %>

data/app/views/wallaby/resources/show/_unsigned_float.html.erb

@@ -0,0 +1,5 @@
+<%# @param object [model] model instance %>
+<%# @param field_name [String] name of the field %>
+<%# @param value [Object] value of the field %>
+<%# @param metadata [Hash] metadata of the field %>
+<%= value.try(:to_f) || null %>

data/app/views/wallaby/resources/show/_unsigned_integer.html.erb

@@ -0,0 +1,5 @@
+<%# @param object [model] model instance %>
+<%# @param field_name [String] name of the field %>
+<%# @param value [Object] value of the field %>
+<%# @param metadata [Hash] metadata of the field %>
+<%= value || null %>

data/app/views/wallaby/resources/show/_uuid.html.erb

@@ -1,3 +1,7 @@
+<%# @param object [model] model instance %>
+<%# @param field_name [String] name of the field %>
+<%# @param value [Object] value of the field %>
+<%# @param metadata [Hash] metadata of the field %>
 <% if value.nil? %>
   <%= null %>
 <% else %>

data/app/views/wallaby/resources/show/_xml.html.erb

@@ -1,3 +1,7 @@
+<%# @param object [model] model instance %>
+<%# @param field_name [String] name of the field %>
+<%# @param value [Object] value of the field %>
+<%# @param metadata [Hash] metadata of the field %>
 <% if value.nil? %>
   <%= null %>
 <% else %>

data/app/views/wallaby/resources/show.html.erb

@@ -2,30 +2,20 @@
 # decorate first on every page or partial
 decorated = decorate resource
 %>
-<article>
-  <%= render 'wallaby/resources/shared/resource_nav' %>
-  <div class="page-header">
-    <h1>
-      <%= show_title decorated %>
-    </h1>
+<article class="resource">
+  <div class="resource__header">
+    <h1><%= show_title decorated %></h1>
+    <%= render 'resource_navs' %>
   </div>
-  <%= render 'wallaby/shared/flash_messages' %>
-  <section class="fields">
-    <table class="detail-table">
-      <thead>
-        <tr>
-          <th>Field</th>
-          <th>Value</th>
-        </tr>
-      </thead>
-      <tbody>
-        <% decorated.show_field_names.each do |field_name| %>
-          <tr>
-            <th><%= decorated.show_label_of field_name %></th>
-            <td><%= type_partial_render decorated.show_type_of(field_name).to_s, object: decorated, field_name: field_name %></td>
-          </tr>
-        <% end %>
-      </tbody>
-    </table>
+  <%= render 'flash_messages' %>
+  <section>
+    <div class="resource__container">
+      <% decorated.show_field_names.each do |field_name| %>
+        <dl>
+          <dt><%= decorated.show_label_of field_name %></dt>
+          <dd><%= type_partial_render decorated.show_type_of(field_name), object: decorated, field_name: field_name %></dd>
+        </dl>
+      <% end %>
+    </div>
   </section>
 </article>

data/app/views/wallaby/resources/show.json.jbuilder

@@ -0,0 +1,5 @@
+# returned the changed resource if frontend needs it
+decorated = decorate resource
+all_field_names =
+  [decorated.primary_key].concat(decorated.show_field_names).uniq
+json.call(decorated, *all_field_names)

data/config/brakeman.ignore

@@ -0,0 +1,26 @@
+{
+  "ignored_warnings": [
+    {
+      "warning_type": "Weak Hash",
+      "warning_code": 90,
+      "fingerprint": "5d66c37f6ad3a0646972a4cc758231c4c0f97dfb156eb73ed07792e19c592b13",
+      "check_name": "WeakHash",
+      "message": "Weak hashing algorithm (MD5) used",
+      "file": "lib/helpers/wallaby/secure_helper.rb",
+      "line": 7,
+      "link": "http://brakemanscanner.org/docs/warning_types/weak_hash/",
+      "code": "Digest::MD5.hexdigest(user.email.downcase)",
+      "render_path": null,
+      "location": {
+        "type": "method",
+        "class": "Wallaby::SecureHelper",
+        "method": "user_portrait"
+      },
+      "user_input": null,
+      "confidence": "Medium",
+      "note": ""
+    }
+  ],
+  "updated": "2017-04-18 13:49:44 +0000",
+  "brakeman_version": "3.6.1"
+}

data/config/locales/wallaby.en.yml

@@ -0,0 +1,91 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  labels:
+    count: 'Count: '
+    auto_select_hint: 'Type to select...'
+    upload: 'Upload'
+
+  buttons:
+    save: 'Save'
+
+  links:
+    new: 'Create %{model}'
+    show: 'Show'
+    edit: 'Edit'
+    delete: 'Delete'
+    cancel: 'Cancel'
+    confirm:
+      delete: 'Please confirm to delete'
+    export: 'Export as %{ext}'
+
+  http_errors:
+    report_error_html: '<p>And report the error <a href="https://github.com/reinteractive/wallaby/issues/new" target="_blank">here</a>.</p>'
+    internal_server_error: 'Hope you feel better.'
+    bad_request: 'Your request is not supported.'
+    not_found: 'Not found.'
+    unprocessable_entity: 'Your request could not be processed.'
+    unauthorized: 'You need to sign in to access this page.'
+    forbidden: 'You need permission to access this page.'
+
+  json_errors:
+    internal_server_error: 'Service unavailable.'
+    bad_request: 'Your request is not supported.'
+    not_found: 'Not found.'
+    unprocessable_entity: 'Your request could not be processed.'
+    unauthorized: 'You need to sign in to access this page.'
+    forbidden: 'You need permission to access this page.'
+
+  errors:
+    not_found:
+      collection: 'Records could not be found. Click + button to add one.'
+      model: 'Model %{model} could not be found.'
+      resource: 'Record %{resource} could not be found.'
+
+  pagination:
+    prev: 'Prev'
+    next: 'Next'
+    from_to: '%{from} to %{to}'
+    of: ' of '
+    total_count: '%{total}'
+    pers: 'Page Size'
+    pages: 'Page Number'
+
+  filters:
+    title: 'Filters'
+    all: 'All'
+
+  search:
+    hint: 'Press enter to search.'
+
+  hints:
+    box_html: 'Format: <code>(x1, y1), (x2, y2)</code> where <i>(x1,y1)</i> and <i>(x2,y2)</i> are any two opposite corners of the box.'
+    cidr_html: 'Example: <code>192.168.1.1/24</code> which holds an IPv4 or IPv6 network specification.'
+    circle_html: 'Format: <code><(x, y), r></code> where <i>(x,y)</i> is the center point and <i>r</i> is the radius of the circle.'
+    hstore_html: 'Format: <code>"Key1" => "Value1", "Key2" => "Value2"</code> is used for input and output, includes zero or more <i>key => value</i> pairs separated by commas.'
+    inet_html: 'Example: <code>192.168.1.1/24</code> which holds an IPv4 or IPv6 network specification.'
+    line_html: 'Format: <code>{ A, B, C }</code> which are represented by the linear equation <i>Ax + By + C = 0</i>.'
+    lseg_html: 'Format: <code>[(x1, y1), (x2, y2)]</code> where <i>(x1,y1)</i> and <i>(x2,y2)</i> are the end points of the line segment.'
+    ltree_html: 'Example: <code>Top.Countries.Europe.Russia</code> which is a sequence of zero or more labels separated by dots.'
+    macaddr_html: 'Example: <code>08:00:2b:01:02:03</code> which stores MAC addresses.'
+    path_html: 'Format: <code>((x1, y1) , ... , (xn, yn))</code> where the points are the end points of the line segments comprising the path.'
+    polygon_html: 'Format: <code>((x1, y1) , ... , (xn, yn))</code> where the points are the end points of the line segments comprising the boundary of the polygon.'

data/config/massa.yml

@@ -0,0 +1,45 @@
+# By leaving this file empty, massa will run all default tools. You can check them here:
+# https://github.com/lucascaton/massa/blob/master/config/default_tools.yml
+# Otherwise you can define your own tools like in the following examples:
+
+rubocop:
+  description: 'Rubocop'
+  command:     'bundle exec rubocop'
+  required:    true
+
+haml_lint:
+  description: 'HAML lint'
+  command:     'bundle exec haml-lint app/views'
+  required:    true
+
+brakeman:
+  description: 'Brakeman (security vulnerability scanner)'
+  command:     'bundle exec brakeman -Aqz4'
+  required:    true
+
+# rails_best_practices:
+#   description: 'Rails Best Practices'
+#   command:     'bundle exec rails_best_practices'
+#   required:    true
+#
+i18n-tasks:
+  description: 'I18n translations'
+  command:     'bundle exec i18n-tasks missing'
+  required:    false
+
+# es_lint:
+#   description: 'ES lint'
+#   command:     'npm run eslint --ext js .'
+#   gem:         false
+#   required:    true
+
+# karma:
+#   description: 'Karma (JS specs)'
+#   command:     'karma start --single-run --browsers PhantomJS'
+#   required:    true
+#   gem:         false
+#
+rspec-rails:
+  description: 'RSpec'
+  command:     'RAILS_ENV=test bundle exec rspec'
+  required:    true

data/config/rails_best_practices.yml

@@ -0,0 +1,42 @@
+AddModelVirtualAttributeCheck: { }
+AlwaysAddDbIndexCheck: { }
+#CheckSaveReturnValueCheck: { }
+#CheckDestroyReturnValueCheck: { }
+DefaultScopeIsEvilCheck: { }
+DryBundlerInCapistranoCheck: { }
+#HashSyntaxCheck: { }
+IsolateSeedDataCheck: { }
+KeepFindersOnTheirOwnModelCheck: { }
+LawOfDemeterCheck: { }
+#LongLineCheck: { max_line_length: 80 }
+MoveCodeIntoControllerCheck: { }
+MoveCodeIntoHelperCheck: { array_count: 3 }
+MoveCodeIntoModelCheck: { use_count: 2 }
+MoveFinderToNamedScopeCheck: { }
+MoveModelLogicIntoModelCheck: { use_count: 4 }
+NeedlessDeepNestingCheck: { nested_count: 2 }
+NotRescueExceptionCheck: { }
+NotUseDefaultRouteCheck: { }
+NotUseTimeAgoInWordsCheck: { }
+OveruseRouteCustomizationsCheck: { customize_count: 3 }
+ProtectMassAssignmentCheck: { }
+RemoveEmptyHelpersCheck: { }
+#RemoveTabCheck: { }
+RemoveTrailingWhitespaceCheck: { }
+RemoveUnusedMethodsInControllersCheck: { except_methods: [], ignored_files: 'app/controllers/wallaby/resources_controller.rb' }
+RemoveUnusedMethodsInHelpersCheck: { except_methods: [] }
+RemoveUnusedMethodsInModelsCheck: { except_methods: [] }
+ReplaceComplexCreationWithFactoryMethodCheck: { attribute_assignment_count: 2 }
+ReplaceInstanceVariableWithLocalVariableCheck: { ignored_files: ['app/views/wallaby/resources/form'] }
+RestrictAutoGeneratedRoutesCheck: { }
+SimplifyRenderInControllersCheck: { }
+SimplifyRenderInViewsCheck: { }
+#UseBeforeFilterCheck: { customize_count: 2 }
+UseModelAssociationCheck: { }
+UseMultipartAlternativeAsContentTypeOfEmailCheck: { }
+#UseParenthesesInMethodDefCheck: { }
+UseObserverCheck: { }
+UseQueryAttributeCheck: { }
+UseSayWithTimeInMigrationsCheck: { }
+UseScopeAccessCheck: { }
+UseTurboSprocketsRails3Check: { }

data/config/routes.rb

@@ -1,32 +1,38 @@
 Wallaby::Engine.routes.draw do
-  root to: 'wallaby/core#home'
+  root to: 'wallaby/resources#home'
 
-  get 'status', to: 'wallaby/core#status'
+  # NOTE: For health check if needed
+  # @see Wallaby::BaseController#healthy
+  get 'status', to: 'wallaby/resources#healthy'
 
+  # To generate error pages for all HTTP status
+  Wallaby::ERRORS.each do |status|
+    code = Rack::Utils::SYMBOL_TO_STATUS_CODE[status]
+    get status, to: "wallaby/resources##{status}"
+    get code.to_s, to: "wallaby/resources##{status}"
+  end
+
+  # This is to pass :resources and :action params onto
+  # `Wallaby::ResourcesRouter`.
+  # So that it could handle the request dispatching.
+  # Currently, it has implemented general CRUD resourceful routes
   scope path: ':resources' do
     with_options to: Wallaby::ResourcesRouter.new do |route|
-      begin # resourceful routes
-        route.get '',
-          defaults: { action: 'index' },
-          as: :resources
-        route.get 'new',
-          defaults: { action: 'new' },
-          as: :new_resource
-        route.get ':id/edit',
-          defaults: { action: 'edit' },
-          as: :edit_resource
-        route.get ':id',
-          defaults: { action: 'show' },
-          as: :resource
+      # @see Wallaby::AbstractResourcesController#index
+      route.get '', defaults: { action: 'index' }, as: :resources
+      # @see Wallaby::AbstractResourcesController#new
+      route.get 'new', defaults: { action: 'new' }, as: :new_resource
+      # @see Wallaby::AbstractResourcesController#edit
+      route.get ':id/edit', defaults: { action: 'edit' }, as: :edit_resource
+      # @see Wallaby::AbstractResourcesController#show
+      route.get ':id', defaults: { action: 'show' }, as: :resource
 
-        route.post '',
-          defaults: { action: 'create' }
-        route.match ':id',
-          via: %i( patch put ),
-          defaults: { action: 'update' }
-        route.delete ':id',
-          defaults: { action: 'destroy' }
-      end
+      # @see Wallaby::AbstractResourcesController#create
+      route.post '', defaults: { action: 'create' }
+      # @see Wallaby::AbstractResourcesController#update
+      route.match ':id', via: %i(patch put), defaults: { action: 'update' }
+      # @see Wallaby::AbstractResourcesController#destroy
+      route.delete ':id', defaults: { action: 'destroy' }
     end
   end
 end

data/lib/adaptors/wallaby/active_record/model_decorator/fields_builder/association_builder.rb

@@ -0,0 +1,39 @@
+module Wallaby
+  class ActiveRecord
+    class ModelDecorator
+      class FieldsBuilder
+        # To build the metadata for associations
+        class AssociationBuilder
+          def update(metadata, reflection)
+            type = reflection.macro
+            metadata[:is_association] = true
+            metadata[:is_through] = through?(reflection)
+            metadata[:has_scope] = scope?(reflection)
+            metadata[:foreign_key] = foreign_key_for(reflection, type)
+          end
+
+          private
+
+          def foreign_key_for(reflection, type)
+            if type == :belongs_to || reflection.polymorphic?
+              reflection.foreign_key
+            elsif reflection.collection?
+              # @see https://github.com/rails/rails/blob/92703a9ea5d8b96f30e0b706b801c9185ef14f0e/activerecord/lib/active_record/associations/builder/collection_association.rb#L50
+              reflection.name.to_s.singularize << '_ids'
+            else
+              reflection.association_foreign_key
+            end
+          end
+
+          def through?(reflection)
+            reflection.is_a? ::ActiveRecord::Reflection::ThroughReflection
+          end
+
+          def scope?(reflection)
+            reflection.scope.present?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adaptors/wallaby/active_record/model_decorator/fields_builder/polymorphic_builder.rb

@@ -0,0 +1,44 @@
+module Wallaby
+  class ActiveRecord
+    class ModelDecorator
+      class FieldsBuilder
+        # To build the metadata for polymorphic
+        class PolymorphicBuilder
+          def update(metadata, reflection)
+            if reflection.polymorphic?
+              metadata[:is_polymorphic] = true
+              metadata[:polymorphic_type] = reflection.foreign_type
+              metadata[:polymorphic_list] = polymorphic_list_for(reflection)
+            else
+              metadata[:class] = reflection.klass
+            end
+          end
+
+          private
+
+          def polymorphic_list_for(reflection)
+            all_model_class.each_with_object([]) do |model_class, list|
+              # TODO: need to check the class as well
+              if polymorphic_defined? model_class, reflection.name
+                list << model_class
+              end
+            end
+          end
+
+          def all_model_class
+            Map
+              .mode_map
+              .select { |_, mode| mode == ::Wallaby::ActiveRecord }.keys
+          end
+
+          def polymorphic_defined?(model_class, polymorphic_name)
+            polymorphic_name_sym = polymorphic_name.try(:to_sym)
+            model_class.reflections.any? do |_field_name, reflection|
+              reflection.options[:as].try(:to_sym) == polymorphic_name_sym
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adaptors/wallaby/active_record/model_decorator/fields_builder/sti_builder.rb

@@ -0,0 +1,42 @@
+module Wallaby
+  class ActiveRecord
+    class ModelDecorator
+      class FieldsBuilder
+        # To build the metadata for sti column
+        class StiBuilder
+          def initialize(model_class)
+            @model_class = model_class
+          end
+
+          def update(metadata, column)
+            return unless @model_class.inheritance_column == column.name
+            metadata[:type] = 'sti'.freeze
+            metadata[:sti_class_list] = sti_list(find_parent_of(@model_class))
+          end
+
+          private
+
+          def sti_list(klass)
+            list = klass
+                   .descendants
+                   .each_with_object([klass]) do |child, result|
+                     result << child
+                   end
+            list.sort_by(&:name)
+          end
+
+          def find_parent_of(model_class)
+            parent = model_class
+            parent = parent.superclass until top_parent?(parent.superclass)
+            parent
+          end
+
+          def top_parent?(klass)
+            klass == ModelFinder.base ||
+              klass.respond_to?(:abstract_class?) && klass.abstract_class?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/adaptors/wallaby/active_record/model_decorator/fields_builder.rb

@@ -1,105 +1,52 @@
-class Wallaby::ActiveRecord::ModelDecorator::FieldsBuilder
-  def initialize(model_class)
-    @model_class = model_class
-  end
-
-  def general_fields
-    @model_class.columns.inject({}) do |fields, column|
-      fields[column.name] = {
-        name:       column.name,
-        type:       column.type.to_s,
-        label:      @model_class.human_attribute_name(column.name),
-        is_origin:  true
-      }
-      fields
-    end
-  end
-
-  def association_fields
-    @model_class.reflections.inject({}) do |fields, (field_name, reflection)|
-      type = extract_type_from reflection
-
-      fields[field_name] = {
-        name:             field_name,
-        type:             type,
-        label:            field_name.titleize,
-        is_origin:        true,
-        is_association:   true,
-        is_polymorphic:   is_polymorphic?(reflection),
-        is_through:       is_through?(reflection),
-        has_scope:        has_scope?(reflection),
-        foreign_key:      foreign_key_for(reflection, type),
-        polymorphic_type: polymorphic_type_for(reflection, type),
-        polymorphic_list: polymorphic_list_for(reflection),
-        class:            class_for(reflection)
-      }
-      fields
-    end
-  end
-
-  protected
-  def has_scope?(reflection)
-    reflection.scope.present?
-  end
+module Wallaby
+  class ActiveRecord
+    class ModelDecorator
+      # To search and build the metadata for fields
+      class FieldsBuilder
+        def initialize(model_class)
+          @model_class = model_class
+        end
 
-  def is_through?(reflection)
-    reflection.respond_to? :delegate_reflection
-  end
+        def general_fields
+          @model_class.columns.each_with_object({}) do |column, fields|
+            metadata = {
+              name: column.name,
+              type: column.type.to_s.freeze,
+              label: @model_class.human_attribute_name(column.name),
+              is_origin: true
+            }
+            sti_builder.update(metadata, column)
+            fields[column.name] = metadata
+          end
+        end
 
-  def is_polymorphic?(reflection)
-    reflection.options[:polymorphic].present?
-  end
+        def association_fields
+          @model_class.reflections.each_with_object({}) do |(name, ref), fields|
+            metadata = {
+              name: name, type: ref.macro.to_s,
+              label: @model_class.human_attribute_name(name),
+              is_origin: true
+            }
+            association_builder.update(metadata, ref)
+            polymorphic_builder.update(metadata, ref)
+            fields[name] = metadata
+          end
+        end
 
-  def extract_type_from(reflection)
-    target = if is_through?(reflection)
-      reflection.delegate_reflection
-    else
-      reflection
-    end
-    target.class.name.match(/([^:]+)Reflection/)[1].underscore
-  end
+        protected
 
-  def foreign_key_for(reflection, type)
-    if 'belongs_to' == type
-      reflection.foreign_key
-    else
-      reflection.association_foreign_key.try do |foreign_key|
-        /many/ =~ type ? "#{ foreign_key }s" : foreign_key
-      end
-    end
-  end
+        def sti_builder
+          @sti_builder ||= StiBuilder.new(@model_class)
+        end
 
-  def polymorphic_type_for(reflection, type)
-    if is_polymorphic? reflection
-      foreign_key = foreign_key_for reflection, type
-      foreign_key.gsub %r(_ids?$), '_type'
-    end
-  end
+        def association_builder
+          @association_builder ||= AssociationBuilder.new
+        end
 
-  def polymorphic_list_for(reflection)
-    if is_polymorphic? reflection
-      available_model_class.inject([]) do |list, model_class|
-        if model_defined_polymorphic_name? model_class, reflection.name
-          list << model_class
+        def polymorphic_builder
+          @polymorphic_builder ||= PolymorphicBuilder.new
         end
-        list
       end
-    end || []
-  end
-
-  def model_defined_polymorphic_name?(model_class, polymorphic_name)
-    model_class.reflections.any? do |field_name, reflection|
-      reflection.options[:as].to_s == polymorphic_name.to_s
     end
   end
-
-  def available_model_class
-    Wallaby::Map.mode_map.select do |_, mode|
-      mode == Wallaby::ActiveRecord
-    end.keys
-  end
-
-  def class_for(reflection)
-    reflection.class_name.constantize if !is_polymorphic? reflection
-  end
 end