trestle-resource_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c69e695763e8a4cc47225caf10e0c03fd4365156bc644d77cff33fef4528aa3b
+  data.tar.gz: 75dc508779e3e0ce1d78938b9a9eb74b92e98481d875f2e192e35e9ec141d7e4
+SHA512:
+  metadata.gz: e923121008b87d753fcf7fec63e9b06d23291d5b75db2500ae6c35364e24830d2403cd70ef9e25bd8a82ef54097074b6dd93363de2d0c858dbc690cba1bcf4c8
+  data.tar.gz: a36e16de13ccc73d85e5de1581fb9a51b67270f99f2a41807a67cd39524ca04fda1b8ba3c31854f521c080145e7fbed242b9586724480e131b2f38891a5bf0c2

data/.gitignore

@@ -0,0 +1,57 @@
+.DS_Store
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/.travis.yml

@@ -0,0 +1,24 @@
+language: ruby
+
+cache: bundler
+
+before_install:
+  - gem update --system
+  - gem install bundler
+
+rvm:
+  - 2.6.5
+
+gemfile:
+  - gemfiles/rails-5.0.gemfile
+  - gemfiles/rails-5.1.gemfile
+  - gemfiles/rails-5.2.gemfile
+  - gemfiles/rails-6.0.gemfile
+  - gemfiles/rails-6.1.gemfile
+  - gemfiles/rails-6.2.gemfile
+
+jobs:
+  include:
+    gemfile: gemfiles/rails-4.2.gemfile
+    before_install:
+      - gem install bundler -v '< 2'

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in trestle-auth.gemspec
+gemspec
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Matthieu "Ezveus" Ciappara
+
+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,28 @@
+# Trestle Model Helper (trestle-resource_helpers)
+
+> Add helpers for Trestle resources
+
+
+## Getting Started
+
+These instructions assume you have a working Trestle application. To integrate trestle-resource_helpers, first add it to your application's Gemfile:
+
+```ruby
+gem 'trestle-resource_helpers'
+```
+
+Run `bundle install`, and then restart your Rails server.
+
+To add a description block within an admin resource, use the `resource_description` method:
+
+```ruby
+Trestle.resource(:articles) do
+  resource_description do
+    'An article is a super dupper class to add some content to the blog!'
+  end
+end
+```
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/stylesheets/trestle/resource_description.css

@@ -0,0 +1,19 @@
+.main-content-header {
+	flex-wrap: wrap;
+	gap: 10px;
+}
+
+.resource-description {
+	width: 100%;
+	color: #5790a0;
+    background-color: #bee6f2;
+    border-color: #b7e4f1;
+    display: flex;
+    position: relative;
+    padding: 1.5rem 1.25rem;
+    margin-bottom: 1rem;
+    border: 1px solid rgba(0,0,0,0);
+    border-radius: 0.1rem;
+    flex-direction: column;
+    align-items: start;
+}

data/app/views/trestle/resource_helpers/_resource_description.html.erb

@@ -0,0 +1,3 @@
+<div class="resource-description">
+  <%= I18n.t("admin.#{admin.model.table_name}.resource_description", default: "No description found for key admin.#{admin.model.table_name}.resource_description") %>
+</div>

data/config/initializers/trestle.rb

@@ -0,0 +1,9 @@
+Trestle.configure do |config|
+  config.hook("stylesheets") do
+    stylesheet_link_tag "trestle/resource_description"
+  end
+
+  config.hook("resource.index.header", if: -> { admin.resource_described? }) do
+    render "trestle/resource_helpers/resource_description"
+  end
+end

data/lib/trestle/resource_helpers/builder.rb

@@ -0,0 +1,11 @@
+module Trestle
+  module ResourceHelpers
+    module Builder
+      def resource_description
+        admin.define_adapter_method(:resource_description) do
+          # noop
+        end
+      end
+    end
+  end
+end

data/lib/trestle/resource_helpers/engine.rb

@@ -0,0 +1,16 @@
+module Trestle
+  module ResourceHelpers
+    class Engine < Rails::Engine
+      config.assets.precompile << 'trestle/resource_description.css'
+
+      # config.to_prepare do
+      #  Trestle::ResourceController.send(:include, Trestle::ResourceHelpers::ControllerConcern)
+      # end
+
+      initializer :extensions do
+        Trestle::Resource.send(:include, Trestle::ResourceHelpers::Resource)
+        Trestle::Resource::Builder.send(:include, Trestle::ResourceHelpers::Builder)
+      end
+    end
+  end
+end

data/lib/trestle/resource_helpers/resource.rb

@@ -0,0 +1,25 @@
+module Trestle
+  module ResourceHelpers
+    module Resource
+      extend ActiveSupport::Concern
+
+      included do
+        prepend Collection
+
+        singleton_class.send(:prepend, Collection)
+      end
+
+      module Collection
+        def resource_description
+          adapter.resource_description if resource_described?
+        end
+      end
+
+      module ClassMethods
+        def resource_described?
+          adapter.respond_to?(:resource_description)
+        end
+      end
+    end
+  end
+end

data/lib/trestle/resource_helpers/version.rb

@@ -0,0 +1,5 @@
+module Trestle
+  module ResourceHelpers
+    VERSION = '0.1.0'
+  end
+end

data/lib/trestle/resource_helpers.rb

@@ -0,0 +1,14 @@
+require_relative 'resource_helpers/version'
+
+require 'trestle'
+
+module Trestle
+  module ResourceHelpers
+
+    require_relative "resource_helpers/builder"
+    require_relative "resource_helpers/resource"
+
+  end
+end
+
+require_relative 'resource_helpers/engine' if defined?(Rails)

data/trestle-resource_helpers.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/trestle/resource_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trestle-resource_helpers"
+  spec.version       = Trestle::ResourceHelpers::VERSION
+
+  spec.authors       = ["Matthieu Ciappara"]
+  spec.email         = ["matthieu.ciappara@outlook.com"]
+
+  spec.summary       = "Add helpers for Trestle resources"
+  spec.homepage      = "https://github.com/Ezveus/trestle-resource_helpers.git"
+  spec.license       = "MIT"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Ezveus/trestle-resource_helpers"
+
+  spec.add_dependency 'rails', '>= 5.2', '< 7'
+  spec.add_dependency "trestle", "~> 0.9.0", ">= 0.9.3"
+
+  spec.add_development_dependency "rspec-rails", "~> 4.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: trestle-resource_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthieu Ciappara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-01-12 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: trestle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: 
+email:
+- matthieu.ciappara@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/trestle/resource_description.css
+- app/views/trestle/resource_helpers/_resource_description.html.erb
+- config/initializers/trestle.rb
+- lib/trestle/resource_helpers.rb
+- lib/trestle/resource_helpers/builder.rb
+- lib/trestle/resource_helpers/engine.rb
+- lib/trestle/resource_helpers/resource.rb
+- lib/trestle/resource_helpers/version.rb
+- trestle-resource_helpers.gemspec
+homepage: https://github.com/Ezveus/trestle-resource_helpers.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Ezveus/trestle-resource_helpers.git
+  source_code_uri: https://github.com/Ezveus/trestle-resource_helpers
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.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: Add helpers for Trestle resources
+test_files: []