madmin 0.1.0

data/lib/madmin/field/polymorphic.rb

@@ -0,0 +1,57 @@
+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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,8 @@
+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

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

data/lib/madmin/generator_helpers.rb

@@ -0,0 +1,13 @@
+module Madmin
+  module GeneratorHelpers
+    def call_generator(generator, *args)
+      Rails::Generators.invoke(generator, args, generator_options)
+    end
+
+    private
+
+    def generator_options
+      {behavior: behavior}
+    end
+  end
+end

data/lib/madmin/resourceable.rb

@@ -0,0 +1,72 @@
+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

@@ -0,0 +1,152 @@
+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

data/lib/madmin/resources.rb

@@ -0,0 +1,13 @@
+module Madmin
+  module Resources
+    # TODO: link to documentation in error message.
+    def self.gather
+      all
+    rescue NoMethodError
+      raise NoResourcesError,
+        "You must define an array of resources as `self.all` in lib/madmin/resources.rb"
+    rescue NameError => e
+      raise ResourceNotFoundError, "Madmin cannot locate the resource #{e.name}."
+    end
+  end
+end

data/lib/madmin/version.rb

@@ -0,0 +1,3 @@
+module Madmin
+  VERSION = "0.1.0"
+end

data/lib/tasks/madmin_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :madmin do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: madmin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Charnes
+- Chris Oliver
+- Andrew Fomera
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Administration for Rails
+email:
+- jason@thecharnes.com
+- excid3@gmail.com
+- andrew@zerlex.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/madmin_manifest.js
+- app/assets/javascripts/madmin/application.js
+- app/assets/javascripts/madmin/dashboard.js
+- app/assets/javascripts/madmin/resources.js
+- app/assets/stylesheets/madmin/application.css
+- app/assets/stylesheets/madmin/dashboard.css
+- app/assets/stylesheets/madmin/resources.css
+- app/controllers/madmin/application_controller.rb
+- app/controllers/madmin/base_controller.rb
+- app/controllers/madmin/dashboard_controller.rb
+- app/controllers/madmin/resources_controller.rb
+- app/decorators/madmin/resource_decorator.rb
+- app/helpers/madmin/application_helper.rb
+- app/helpers/madmin/fields/polymorphic_helper.rb
+- app/jobs/madmin/application_job.rb
+- app/mailers/madmin/application_mailer.rb
+- app/models/madmin/application_record.rb
+- app/views/application/_navigation.html.erb
+- app/views/layouts/madmin/application.html.erb
+- app/views/madmin/dashboard/index.html.erb
+- app/views/madmin/fields/belongs_to/_form.html.erb
+- app/views/madmin/fields/belongs_to/_index.html.erb
+- app/views/madmin/fields/belongs_to/_show.html.erb
+- app/views/madmin/fields/check_box/_form.html.erb
+- app/views/madmin/fields/check_box/_index.html.erb
+- app/views/madmin/fields/check_box/_show.html.erb
+- app/views/madmin/fields/email/_form.html.erb
+- app/views/madmin/fields/email/_index.html.erb
+- app/views/madmin/fields/email/_show.html.erb
+- app/views/madmin/fields/has_many/_form.html.erb
+- app/views/madmin/fields/has_many/_show.html.erb
+- app/views/madmin/fields/has_one/_form.html.erb
+- app/views/madmin/fields/has_one/_show.html.erb
+- app/views/madmin/fields/number/_form.html.erb
+- app/views/madmin/fields/number/_index.html.erb
+- app/views/madmin/fields/number/_show.html.erb
+- app/views/madmin/fields/password/_form.html.erb
+- app/views/madmin/fields/password/_index.html.erb
+- app/views/madmin/fields/password/_show.html.erb
+- app/views/madmin/fields/polymorphic/_form.html.erb
+- app/views/madmin/fields/polymorphic/_index.html.erb
+- app/views/madmin/fields/polymorphic/_show.html.erb
+- app/views/madmin/fields/select/_form.html.erb
+- app/views/madmin/fields/select/_index.html.erb
+- app/views/madmin/fields/select/_show.html.erb
+- app/views/madmin/fields/text/_form.html.erb
+- app/views/madmin/fields/text/_index.html.erb
+- app/views/madmin/fields/text/_show.html.erb
+- app/views/madmin/fields/text_area/_form.html.erb
+- app/views/madmin/fields/text_area/_index.html.erb
+- app/views/madmin/fields/text_area/_show.html.erb
+- app/views/madmin/resources/_form.html.erb
+- app/views/madmin/resources/_scopes.html.erb
+- app/views/madmin/resources/edit.html.erb
+- app/views/madmin/resources/index.html.erb
+- app/views/madmin/resources/index/_content.html.erb
+- app/views/madmin/resources/new.html.erb
+- app/views/madmin/resources/show.html.erb
+- config/routes.rb
+- lib/generators/madmin/controller/USAGE
+- lib/generators/madmin/controller/controller_generator.rb
+- lib/generators/madmin/install/install_generator.rb
+- lib/generators/madmin/page/USAGE
+- lib/generators/madmin/page/page_generator.rb
+- lib/generators/madmin/page/templates/template.html.erb
+- lib/generators/madmin/page/templates/template.rb.erb
+- lib/generators/madmin/resource/resource_generator.rb
+- lib/generators/madmin/resource/templates/resource.rb.erb
+- lib/generators/madmin/views/views_generator.rb
+- lib/madmin.rb
+- lib/madmin/engine.rb
+- lib/madmin/field.rb
+- lib/madmin/field/associatable.rb
+- lib/madmin/field/belongs_to.rb
+- lib/madmin/field/check_box.rb
+- lib/madmin/field/date_time.rb
+- lib/madmin/field/email.rb
+- lib/madmin/field/has_many.rb
+- lib/madmin/field/has_one.rb
+- lib/madmin/field/number.rb
+- lib/madmin/field/password.rb
+- lib/madmin/field/polymorphic.rb
+- lib/madmin/field/select.rb
+- lib/madmin/field/text.rb
+- lib/madmin/field/text_area.rb
+- lib/madmin/generator_helpers.rb
+- lib/madmin/resourceable.rb
+- lib/madmin/resourceable/class_methods.rb
+- lib/madmin/resources.rb
+- lib/madmin/version.rb
+- lib/tasks/madmin_tasks.rake
+homepage: https://madmin.jasoncharnes.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Administration for Rails
+test_files: []