backend 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 03dad73a5e8c0fcfc1ff9356618c39b383070f0f2d1e38b0fc7ea635b763ad14
+  data.tar.gz: f0c1ed7b295b475ef6abd756c3c217317fe993036114152ee0a8158b1a16d590
+SHA512:
+  metadata.gz: 92af0f420ee201dc1a742b7e0448572378b430f886ce665e250d0babdc0af09a6311b9b57a6bd1dffaba03f1fa0ba03f6b806198a5cee472afdca59b96007b08
+  data.tar.gz: 409f2600bcf7ae40464583bee6edf38717ecdb287c4fdfa3d91b5a9347e127cb4d8ecbfa166bee99a2bce79e6836c81f2906c14581b258fb22075d3a81d6f57e

data/README.md

@@ -0,0 +1,41 @@
+Backend 
+==============
+[![RuboCop Github Action](https://github.com/kiqr/backend/actions/workflows/rubocop.yml/badge.svg)](https://github.com/kiqr/backend/actions/workflows/rubocop.yml)
+[![RSpec](https://github.com/kiqr/backend/actions/workflows/rspec.yml/badge.svg)](https://github.com/kiqr/backend/actions/workflows/rspec.yml)
+[![MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE.md)
+
+An administration panel for Ruby on Rails.
+
+Installation
+------------
+
+Add the following line to Gemfile:
+
+```ruby
+gem "backend", "~> 1.0"
+```
+
+and run `bundle install` from your terminal to install it.
+
+Contributing
+------------
+If you are interested in reporting/fixing issues and contributing directly to the code base, please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information on what we're looking for and how to get started.
+
+Versioning
+----------
+This library aims to adhere to [Semantic Versioning](http://semver.org/). Violations
+of this scheme should be reported as bugs. Specifically, if a minor or patch
+version is released that breaks backward compatibility, that version should be
+immediately yanked and/or a new version should be immediately released that
+restores compatibility. Breaking changes to the public API will only be
+introduced with new major versions. As a result of this policy, you can (and
+should) specify a dependency on this gem using the [Pessimistic Version
+Constraint](http://guides.rubygems.org/patterns/#pessimistic-version-constraint) with two digits of precision. For example:
+
+```ruby
+gem "backend", "~> 1.0"
+```
+
+License
+-------
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/backend/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Backend
+  class Engine < ::Rails::Engine
+    isolate_namespace Backend
+  end
+end

data/lib/backend/field/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Backend
+  module Field
+    class Base
+      attr_reader :name
+
+      def initialize(name)
+        @name = name.to_sym
+      end
+    end
+  end
+end

data/lib/backend/field/editor.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Backend
+  module Field
+    class Editor < Backend::Field::Base; end
+  end
+end

data/lib/backend/field/string.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Backend
+  module Field
+    class String < Backend::Field::Base; end
+  end
+end

data/lib/backend/resource.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Backend
+  class Resource
+    extend ActiveSupport::DescendantsTracker
+
+    # Define class accessors.
+    class_attribute :fields, instance_accessor: false
+
+    class << self
+      # Return demodulized and stripped class name in plural form.
+      def scope
+        @scope ||= klass_name.pluralize.underscore
+      end
+
+      # Return the related model class.
+      def klass
+        @klass ||= klass_name.constantize
+      end
+
+      # Human readable name of the resource.
+      def resource_name
+        klass.model_name.human
+      end
+
+      # Base parameter for form requests.
+      def resource_param
+        resource_name.downcase.underscore.to_sym
+      end
+
+      delegate :to_sym, to: :scope
+
+      private
+
+      # Normalized class name.
+      #
+      # Returns the demodulized and stripped class name without Resource in the end.
+      # Example:
+      #   CategoryResource => Category
+      def klass_name
+        @klass_name ||= name.demodulize.chomp("Resource")
+      end
+
+      # Field.
+      #
+      # Register a new editable field for the resource.
+      # The type of field can be set with the :type option.
+      # The default type is :string.
+      #
+      # Example:
+      #   field :title,  type: :string    => Backend::Fields::String.new(:title)
+      #   field :body,   type: :editor    => Backend::Fields::Editor.new(:body)
+      #   field :status, type: :boolean   => Backend::Fields::Boolean.new(:status)
+      #
+      # :api: public
+      def field(name, type: :base)
+        klass = Backend::Field.const_get(type.to_s.classify)
+        field = klass.new(name)
+
+        # Create empty array if #fields is nil.
+        self.fields ||= []
+
+        # Insert field into the array.
+        self.fields << field
+      end
+    end
+  end
+end

data/lib/backend/version.rb

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

data/lib/backend.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "backend/version"
+require "backend/engine"
+require "dry-configurable"
+
+module Backend
+  extend Dry::Configurable
+
+  autoload "Resource", "backend/resource"
+
+  module Field
+    autoload "Base", "backend/field/base"
+    autoload "Editor", "backend/field/editor"
+    autoload "String", "backend/field/string"
+  end
+
+  setting :route_scope, "backend" # Default route scope for backend routes.
+
+  class << self
+    def resources
+      # Force eager load of all resources.
+      # Todo: this could be changed to a
+      # script that requires all files in app/backend.
+      Rails.application.eager_load!
+
+      # that has inherited from Backend::Resource.
+      Backend::Resource.descendants
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: backend
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- KIQR
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description:
+email: hello@kiqr.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/backend.rb
+- lib/backend/engine.rb
+- lib/backend/field/base.rb
+- lib/backend/field/editor.rb
+- lib/backend/field/string.rb
+- lib/backend/resource.rb
+- lib/backend/version.rb
+homepage: https://github.com/kiqr/backend
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/kiqr/authenticatable/issues
+  documentation_uri: https://github.com/kiqr/authenticatable/issues
+  source_code_uri: https://github.com/kiqr/authenticatable
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: An administration panel for Ruby on Rails.
+test_files: []