kadim 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3272545bc64e3a1c4568f3203620fb693c7c9296ae29be131f6ff29bf7cdf647
+  data.tar.gz: abe7c623093b1e6c8da72df5a25d12c281a62f6b8af66e8c8562cc06525c5edb
+SHA512:
+  metadata.gz: 6b8a8534aa0071b3bf94e4374d644795438a0fd2d81974f8a62db750ad43d041d00d4beac5262136bd5a9208b8802ede6c7e62f073980f6b389948b68127dfdb
+  data.tar.gz: e8b2b2b9eb52fa33604e32bcb2c3c8f95c034dea4a0fedf525c54381d5b4182ec979bf62e65bbfee742ef67630180eb1cdbab24f2bb73c4ef9532a682d98056d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Kadu Diógenes
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# kadim
+Yet another Rails admin? No, only a kadim!*
+
+Admin is all about CRUD, right?
+
+My biggest experience with admins is with RailsAdmin. I currently work with an application that makes extensive use of
+it and all my peers hate having to customize anything on it, me too!
+
+If I have used administrate or trestle? Yes, I've tried it, but isn't reinventing the wheel super cool? In fact I
+believe a less DSL-focused admin would be better.
+
+I just got annoyed at just criticizing existing solutions and decided to get my hands dirty to put my vision into
+practice.
+
+** kadim: derived from "cadim", an expression from the brazillian mineiro dialect that means "a little bit".*
+
+## Usage
+In the current incarnation, it's very crud (no pun intended) and there is no configuration, everything works by
+convention.
+
+For each model of your application will be generated a controller and their views, using the Rails generator
+scaffold_controller, using all columns present in your model. Relations, ActiveStorage attachments and other
+ActiveRecord methods added by gems are ignored.
+
+Files are generated in `tmp/kadim` and loaded into memory, including views. This also has the advantage of allowing the
+gem to work in environments with ephemeral file systems.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kadim'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install kadim
+```
+
+## Roadmap
+- [x] Dynamic CRUD generation from application models
+- [ ] Tasks to copy files form kadim to the hosted application
+- [ ] Add support to ActiveStorage attachments
+- [ ] Add support to belongs_to relationships
+- [ ] Add a beautiful look and feel
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Kadim"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/kadim_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/kadim .css

data/app/assets/javascripts/kadim/application.js

@@ -0,0 +1 @@
+//= require rails-ujs

data/app/assets/stylesheets/kadim/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/kadim/application_controller.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Kadim
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+    append_view_path Kadim::MemoryResolver.instance
+  end
+end

data/app/helpers/kadim/application_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Kadim
+  module ApplicationHelper
+    def menu_links
+      links = Kadim.app_model_names.map(&:camelize).map(&:constantize).map do |model_klass|
+        link_to model_klass.model_name.human(count: :many), model_klass
+      end
+      safe_join(links, " | ")
+    end
+  end
+end

data/app/jobs/kadim/application_job.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Kadim
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/kadim/application_mailer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Kadim
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/views/kadim/application/index.html.erb

@@ -0,0 +1,8 @@
+<p>- Hi, I'm kadim!</p>
+<p>- Yet another Rails admin?</p>
+<p>- No, only a kadim!</p>
+<small>
+  <i>
+    * kadim: derived from "cadim", an expression from the brazillian mineiro dialect, that means "a little bit".
+  </i>
+</small>

data/app/views/layouts/kadim/application.html.erb

@@ -0,0 +1,19 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Kadim</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag 'kadim/application', media: 'all', 'data-turbolinks-track': 'reload' %>
+  <%= javascript_include_tag 'kadim/application', 'data-turbolinks-track': 'reload' %>
+</head>
+<body>
+
+<div class="menu">
+  <%= menu_links %>
+</div>
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+Kadim::Engine.routes.draw do
+  Kadim.app_model_names.map(&:tableize).each do |table_name|
+    resources table_name
+  end
+  root "application#index"
+end

data/lib/kadim/engine.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Kadim
+  class Engine < ::Rails::Engine
+    isolate_namespace Kadim
+
+    config.to_prepare do
+      Kadim.bootstrap_controllers
+    end
+
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+  end
+end

data/lib/kadim/template/memory_resolver.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module Kadim
+  class MemoryResolver < ActionView::Resolver
+    include Singleton
+
+    class TemplateStore
+      SmallCache = ActionView::Resolver::Cache::SmallCache
+
+      PARTIAL_BLOCK = ->(store, partial) { store[partial] = SmallCache.new }
+      PREFIX_BLOCK  = ->(store, prefix)  { store[prefix]  = SmallCache.new(&PARTIAL_BLOCK) }
+      NAME_BLOCK    = ->(store, name)    { store[name]    = SmallCache.new(&PREFIX_BLOCK)  }
+
+      # usually a majority of template look ups return nothing, use this canonical preallocated array to save memory
+      NO_TEMPLATES = [].freeze
+
+      def initialize
+        @data = SmallCache.new(&NAME_BLOCK)
+      end
+
+      def find(name, prefix, partial)
+        @data[name][prefix][partial].presence || NO_TEMPLATES
+      end
+
+      def add(body, path, partial)
+        name = path.split("/").last
+        name = name[1..-1] if partial
+        prefix = path.split("/")[0..-2].join("/")
+        @data[name][prefix][partial] = body
+      end
+
+      def clear
+        @data.clear
+      end
+    end
+
+    def initialize
+      @cache = Cache.new
+      @store = TemplateStore.new
+    end
+
+    def add(body, path)
+      partial = path.split("/").last.start_with?("_")
+      @store.add(body, path, partial)
+    end
+
+    def clear
+      @cache.clear
+      @store.clear
+    end
+
+    private
+      def find_templates(name, prefix, partial, details, locals = [])
+        return unless details[:formats].include?(:html) && details[:handlers].include?(:erb)
+
+        body = @store.find(name, prefix, partial)
+        return body if body.empty?
+
+        path = normalize_path(name, prefix)
+        identifier = "#{virtual_path(path, partial)}.html.erb (kadim memory resolver)"
+        handler = ActionView::Template.registered_template_handler(:erb)
+        details = { format: :html, virtual_path: virtual_path(path, partial), locals: locals }
+
+        [ActionView::Template.new(body, identifier, handler, details)]
+      end
+
+      # Normalize name and prefix, so the tuple ["index", "users"] becomes "users/index" and the tuple
+      # ["template", nil] becomes "template".
+      def normalize_path(name, prefix)
+        prefix.present? ? "#{prefix}/#{name}" : name
+      end
+
+      # Make paths as "users/user" become "users/_user" for partials.
+      def virtual_path(path, partial)
+        return path unless partial
+
+        if (index = path.rindex("/"))
+          path.dup.insert(index + 1, "_")
+        else
+          "_#{path}"
+        end
+      end
+  end
+end

data/lib/kadim/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Kadim
+  VERSION = "0.1.0"
+end

data/lib/kadim.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/rails/scaffold_controller/scaffold_controller_generator"
+
+require "kadim/engine"
+require "kadim/template/memory_resolver"
+
+module Kadim
+  def self.app_model_names
+    Dir[Rails.root.join("app", "models", "**", "*.rb")]
+      .reject { |model_path| model_path.include?("/concerns/") || model_path.include?("application_record") }
+      .map    { |model_path| model_path.remove(%r{.*/app/models/}, ".rb") }
+      .select { |model_name| model_name.camelize.constantize.table_exists? }
+      .sort
+  end
+
+  def self.bootstrap_controllers
+    cleanup
+    scaffold_controllers
+  end
+
+  class << self
+    private
+      def cleanup
+        cleanup_tmp_files
+        cleanup_kadim_consts
+      end
+
+      def cleanup_tmp_files
+        FileUtils.remove_dir(Rails.root.join("tmp", "kadim"), true)
+      end
+
+      def cleanup_kadim_consts
+        controller_filenames.each do |controller_filename|
+          next if File.exist?(Rails.root.join("app", "controllers", "kadim", "#{controller_filename}.rb"))
+
+          controller_klass = controller_filename.camelize
+          Kadim.send(:remove_const, controller_klass) if Kadim.const_defined?(controller_klass, false)
+        end
+      end
+
+      def controller_filenames
+        app_model_names.map { |model_name| "#{model_name.pluralize}_controller" }
+      end
+
+      def scaffold_controllers
+        current_namespace = Rails::Generators.namespace
+        Rails::Generators.namespace = Kadim
+        app_model_names.each { |model_name| scaffold_controller(model_name) }
+        load_kadim_controllers
+        load_kadim_views
+      ensure
+        Rails::Generators.namespace = current_namespace
+      end
+
+      def scaffold_controller(model_name)
+        model_klass = model_name.camelize.constantize
+        return unless model_klass.table_exists?
+
+        generator = Rails::Generators::ScaffoldControllerGenerator.new(
+          [model_name, *scaffold_attributes(model_klass)],
+          ["--force", "--quiet", "--no-orm", "--no-test-framework", "--no-helper"],
+          destination_root: Rails.root.join("tmp", "kadim")
+        )
+        generator.invoke_all
+      end
+
+      def scaffold_attributes(model_klass)
+        model_klass.columns
+                   .reject { |column| %w[id created_at updated_at].include?(column.name) }
+                   .sort_by(&:name)
+                   .map { |column| [column.name, column.type] }
+                   .to_h
+                   .map { |k, v| "#{k}:#{v}" }
+      end
+
+      def load_kadim_controllers
+        Dir[Rails.root.join("tmp", "kadim", "app", "controllers", "**", "*_controller.rb")].each { |path| load path }
+      end
+
+      def load_kadim_views
+        Kadim::MemoryResolver.instance.clear
+        Dir[Rails.root.join("tmp", "kadim", "app", "views", "**", "*.html.erb")].each do |file_path|
+          view_match = %r{.*/app/views/(.*)(\.html\.erb)}.match(file_path)
+          view_path = view_match[1]
+          Kadim::MemoryResolver.instance.add(IO.read(file_path), view_path)
+        end
+      end
+  end
+end

data/lib/tasks/kadim_tasks.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# desc "Explaining what the task does"
+# task :kadim do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,243 @@
+--- !ruby/object:Gem::Specification
+name: kadim
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kadu Diógenes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activestorage-resumable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.29.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.29.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.72.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.142.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.142.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+description: Don't let admins pull out your hair!
+email:
+- kadu@fnix.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/kadim_manifest.js
+- app/assets/javascripts/kadim/application.js
+- app/assets/stylesheets/kadim/application.css
+- app/controllers/kadim/application_controller.rb
+- app/helpers/kadim/application_helper.rb
+- app/jobs/kadim/application_job.rb
+- app/mailers/kadim/application_mailer.rb
+- app/views/kadim/application/index.html.erb
+- app/views/layouts/kadim/application.html.erb
+- config/routes.rb
+- lib/kadim.rb
+- lib/kadim/engine.rb
+- lib/kadim/template/memory_resolver.rb
+- lib/kadim/version.rb
+- lib/tasks/kadim_tasks.rake
+homepage: https://github.com/fnix/kadim
+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.3
+signing_key: 
+specification_version: 4
+summary: Yet another Rails admin? No, only a kadim.
+test_files: []