madmin 0.1.0 → 1.0.1

data/lib/generators/madmin/page/USAGE

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

data/lib/generators/madmin/page/page_generator.rb

@@ -1,20 +0,0 @@
-class Madmin::PageGenerator < Rails::Generators::NamedBase
-  source_root File.expand_path("templates", __dir__)
-
-  def copy_template
-    template(
-      "template.rb.erb",
-      Rails.root.join("app/controllers/madmin/#{file_name}_controller.rb"),
-    )
-
-    template(
-      "template.html.erb",
-      Rails.root.join("app/views/madmin/#{file_name}/index.html.erb"),
-    )
-
-    inject_into_file(
-      Rails.root.join("config/routes.rb"),
-      after: "namespace :madmin do\n"
-    ) { "    get \"#{file_name}\", to: \"#{file_name}#index\"\n" }
-  end
-end

data/lib/generators/madmin/page/templates/template.html.erb

@@ -1,2 +0,0 @@
-<h1><%= name %></h1>
-<p>Find me in apps/views/madmin/<%= file_name %>/index.erb</p>

data/lib/generators/madmin/page/templates/template.rb.erb

@@ -1,10 +0,0 @@
-class Madmin::<%= name %>Controller < Madmin::ApplicationController
-  def index
-  end
-
-  private
-
-  def in_menu?
-    true
-  end
-end

data/lib/generators/madmin/resource/templates/resource.rb.erb

@@ -1,11 +0,0 @@
-module Madmin
-  class Resources
-    class <%= class_name %>
-      include Madmin::Resourceable
-
-<% (attributes + associations ).each do |name, type| -%>
-      field :<%= name %>, Madmin::<%= type %>
-<% end -%>
-    end
-  end
-end

data/lib/madmin/field/associatable.rb

@@ -1,58 +0,0 @@
-module Madmin
-  class Field
-    module Associatable
-      class << self
-        def included(_base)
-          attr_reader :association_class
-          attr_reader :association_display_value
-          attr_reader :association_foreign_key
-          attr_reader :association_scope
-        end
-      end
-
-      def initialize(args)
-        super(args)
-        implement_association!
-      end
-
-      def association_collection
-        association_class.send(association_scope)
-      end
-
-      def association_id_for(resource)
-        value_for(resource).id
-      end
-
-      def association_id_or_blank_for(resource)
-        value_for(resource).try(:id)
-      end
-
-      def association_param
-        ActiveModel::Naming.param_key(association_class)
-      end
-
-      def association_slug
-        Object.const_get("::Madmin::Resources::#{association_class}").new.slug
-      end
-
-      def association_value_for(resource)
-        value_for(resource).send(association_display_value)
-      end
-
-      def strong_params_keys
-        [association_foreign_key]
-      end
-
-      private
-
-      def implement_association!
-        association = model.reflect_on_all_associations.find { |assc| assc.name == key }
-
-        @association_class         = association.klass
-        @association_display_value = option_or_default(:display_value, :name)
-        @association_foreign_key   = association.foreign_key
-        @association_scope         = :all
-      end
-    end
-  end
-end

data/lib/madmin/field/belongs_to.rb

@@ -1,9 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents a :belongs_to relationship within a Rails model.
-    class BelongsTo < Madmin::Field
-      include Madmin::Field::Associatable
-    end
-  end
-end

data/lib/madmin/field/check_box.rb

@@ -1,8 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents a checkbox (boolean) value.
-    class CheckBox < Madmin::Field
-    end
-  end
-end

data/lib/madmin/field/date_time.rb

@@ -1,8 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents a datetime value.
-    class DateTime < Madmin::Field
-    end
-  end
-end

data/lib/madmin/field/email.rb

@@ -1,8 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents an email value.
-    class Email < Madmin::Field
-    end
-  end
-end

data/lib/madmin/field/has_many.rb

@@ -1,9 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents a :has_many relationship within a Rails model.
-    class HasMany < Madmin::Field
-      include Madmin::Field::Associatable
-    end
-  end
-end

data/lib/madmin/field/has_one.rb

@@ -1,9 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents a :has_one relationship within a Rails model.
-    class HasOne < Madmin::Field
-      include Madmin::Field::Associatable
-    end
-  end
-end

data/lib/madmin/field/number.rb

@@ -1,8 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents a number value.
-    class Number < Madmin::Field
-    end
-  end
-end

data/lib/madmin/field/password.rb

@@ -1,8 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents a password value.
-    class Password < Madmin::Field
-    end
-  end
-end

data/lib/madmin/field/polymorphic.rb

@@ -1,57 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents a polymorphic relationship.
-    class Polymorphic < Madmin::Field
-      attr_reader :polymorphic_display_value
-      attr_reader :polymorphic_scope
-
-      def initialize(args)
-        super(args)
-        @polymorphic_display_value = option_or_default(:display_value, :name)
-        @polymorphic_scope = :all
-      end
-
-      ##
-      # Returns the id for the associated polymorphic record.
-      def polymorphic_id_for(resource)
-        value_for(resource).id
-      end
-
-      ##
-      # Returns the polymorphic ID param.
-      def polymorphic_id_param
-        "#{key}_id".to_sym
-      end
-
-      def polymorphic_relationship_exists?(resource)
-        resource.send(polymorphic_type_param) && resource.send(polymorphic_id_param)
-      end
-
-      ##
-      # Returns the slug for the polymorphic resource.
-      def polymorphic_slug_for(resource)
-        Object.const_get("::Madmin::Resources::#{resource.send("#{key}_type")}").new.slug
-      end
-
-      ##
-      # Returns the polymorphic type param.
-      def polymorphic_type_param
-        "#{key}_type".to_sym
-      end
-
-      ##
-      # Returns the value to show in the admin
-      # for the polymorphic relationship.
-      def polymorphic_value_for(resource)
-        value_for(resource).send(polymorphic_display_value)
-      end
-
-      ##
-      # Returns the polymorphic stront params keys.
-      def strong_params_keys
-        [polymorphic_id_param, polymorphic_type_param]
-      end
-    end
-  end
-end

data/lib/madmin/field/select.rb

@@ -1,13 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents a select dropdown value.
-    class Select < Madmin::Field
-      attr_reader :select_options
-
-      def initialize(args)
-        @select_options = option_or_default(:collection, [])
-      end
-    end
-  end
-end

data/lib/madmin/field/text.rb

@@ -1,8 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents a plain old text field.
-    class Text < Madmin::Field
-    end
-  end
-end

data/lib/madmin/field/text_area.rb

@@ -1,8 +0,0 @@
-module Madmin
-  class Field
-    ##
-    # This field represents a textarea value.
-    class TextArea < Madmin::Field
-    end
-  end
-end

data/lib/madmin/resourceable.rb

@@ -1,72 +0,0 @@
-require "madmin/resourceable/class_methods"
-
-##
-# This module is the heart of a Madmin Resource.
-# When included into a resource class, the
-# resource is given a DSL for registering
-# fields, scopes, and more.
-module Madmin
-  module Resourceable
-    class << self
-      def included(base)
-        base.extend Madmin::Resourceable::ClassMethods
-      end
-    end
-
-    ##
-    # This method returns a list of fields where
-    # the index option is truthy.
-    def form_fields
-      self.class.fields.values.select { |field| field.form }
-    end
-
-    ##
-    # This methods exposes the underlying resource's name
-    # in a way humans can enjoy and understand.
-    def friendly_name
-      self.class.model_name.split("::").join(" ")
-    end
-
-    ##
-    # This method returns a list of fields where
-    # the index option is truthy.
-    def index_fields
-      self.class.fields.values.select { |field| field.index }
-    end
-
-    ##
-    # This method returns a list of labels for fields
-    # where the index option is truthy.
-    def index_headers
-      index_fields.map { |field| field.label }
-    end
-
-    ##
-    # This method affords us the ability to retrieve
-    # a list of the scopes from the class variable.
-    def scopes
-      self.class.scopes
-    end
-
-    ##
-    # This method exposes a way to control if the
-    # resource should visible in the menu.
-    def show_in_menu?
-      true
-    end
-
-    ##
-    # This method, when used in the resource, sets all fields
-    # to be used when the show partial is rendered.
-    def show_fields
-      self.class.fields.values.select { |field| field.show }
-    end
-
-    ##
-    # This method affords us the ability to have a
-    # consistently rendered slug for a resource.
-    def slug
-      ActiveModel::Naming.route_key(self.class.model)
-    end
-  end
-end

data/lib/madmin/resourceable/class_methods.rb

@@ -1,152 +0,0 @@
-module Madmin
-  module Resourceable
-    ##
-    # This module extends methods into class methods on the resource.
-    module ClassMethods
-      ##
-      # This method is a wrapper for the class variable fields.
-      # In the event there is no field defined yet, we rescue
-      # NameError and return an empty hash to begin the
-      # population of the fields class variable.
-      def fields
-        class_variable_get(:@@fields)
-      rescue NameError
-        {}
-      end
-
-      ##
-      # This becomes a DSL for adding a field into the fields class variable.
-      # It is responsible for validating and parsing the arguments before
-      # placing them into the fields class variable.
-      def field(*args)
-        validate_arguments!(args)
-
-        key        = args[0].to_sym
-        field_type = args[1]
-
-        # We reassign the entire list of fields to prevent
-        # duplication each time the class is evaluated.
-        fresh_fields = fields
-        fresh_fields[key] = field_type.new(args[2].merge(key: key, model: model, resource: self))
-
-        class_variable_set(:@@fields, fresh_fields)
-      end
-
-      ##
-      # This method is a wrapper for the class variable scopes.
-      # In the event there is no scope defined yet, we rescue
-      # NameError and return an empty array to begin the
-      # population of the scopes class variable.
-      def scopes
-        class_variable_get(:@@scopes)
-      rescue NameError
-        []
-      end
-
-      ##
-      # This becomes a DSL for adding a field into the scopes class variable.
-      # It is responsible for validating and parsing the arguments before
-      # placing them into the scopes class variable.
-      def scope(*args)
-        validate_scopes!(args)
-
-        # We reassign the entire list of scopes to prevent
-        # duplication each time the class is evaluated.
-        fresh_scopes = scopes << args
-
-        class_variable_set(:@@scopes, fresh_scopes.flatten.uniq)
-      end
-
-      ##
-      # This method, when used in the resource, sets all fields
-      # to be used when the form partial is rendered.
-      def form_all_fields!
-        class_variable_set(:@@form_all_fields, true)
-      end
-
-      ##
-      # This method exposes a convenient way to see if all fields
-      # for a resource should be available in a form partial.
-      def form_all_fields?
-        class_variable_get(:@@form_all_fields)
-      rescue NameError
-        false
-      end
-
-      ##
-      # This method exposes the underlying model.
-      def model
-        model_name.constantize
-      end
-
-      ##
-      # This method extracts the namespace to reveal
-      # the underlying models name as a string.
-      def model_name
-        to_s.split("Madmin::Resources::").last.to_s
-      end
-
-      ##
-      # This method exposes a convenient way to see if all fields
-      # for a resource should be available in a show partial.
-      def show_all_fields!
-        class_variable_set(:@@show_all_fields, true)
-      end
-
-      ##
-      # This method exposes a convenient way to see if all fields
-      # for a resource should be available in a show partial.
-      def show_all_fields?
-        class_variable_get(:@@show_all_fields)
-      rescue NameError
-        false
-      end
-
-      private
-
-      ##
-      # This method validates that a given attribute for
-      # a field is provided in the correct format of
-      # either a symbol or a string.
-      def attribute?(attribute)
-        attribute.is_a?(Symbol) || attribute.is_a?(String)
-      end
-
-      ##
-      # We want to make sure a provided type is
-      # registered within our system.
-      def valid_type?(type)
-        type.to_s.deconstantize == Madmin::Field.to_s
-      end
-
-      ##
-      # This method looks at the first two arguments (attribute, type)
-      # and performs their prospective validations. If either
-      # validation fails, a WrongArgumentError is raised.
-      def validate_arguments!(args)
-        if !attribute?(args.first)
-          raise WrongArgumentError,
-            "#{model_name} expected the attribute name as a symbol or string as the first argument."
-        elsif !valid_type?(args.second)
-          raise WrongArgumentError,
-            "#{model_name} expected Madmin::Field type as the field type as the second argument."
-        end
-      end
-
-      ##
-      # This method looks at a given scope(s) and validates
-      # the scope exists on the underlying model.
-      #
-      # Rails scopes are defined as class methods as the
-      # class is evaluated, requiring this method
-      # of performing the validation.
-      def validate_scopes!(args)
-        args.each do |arg|
-          unless model.respond_to?(arg)
-            raise UndefinedScopeError, ".#{arg} is not a valid scope on #{name}"
-          end
-        end
-      end
-    end
-  end
-end