auto_view_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6dda316a58b8a4adbd1789c772fd3a07d86b2df2b3f71c9d6b818a22c188bca9
+  data.tar.gz: 22eaa4fc73258bf12eb7b33c8648d06d1c059366849a731b637c96f9767c99b1
+SHA512:
+  metadata.gz: 261135d6e20c26a352c6bb41088d0dc3c3f961265758b53e1e1ad4de542d1df38af17a7f7e17148d039c38595e9ddeaa9f36d71cbaefef0e9b74ff3ffff5e108
+  data.tar.gz: fe8a175d41452325cf7dab7a946f01acaa87ff5b21b34345f6e2f3a226546914ea3b1adec8f517eaa06e1f9301f8419c885e2014911e6fc6d89c900461e40824

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.14
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-04-26
+
+- Initial release

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in auto_view_model.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rails", "~> 6.1"
+
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,151 @@
+PATH
+  remote: .
+  specs:
+    auto_view_model (0.1.0)
+      actionview (~> 6.1)
+      activesupport (~> 6.1)
+      pry (~> 0.14)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.3.1)
+      activesupport (= 6.1.3.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activestorage (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      marcel (~> 1.0.0)
+      mini_mime (~> 1.0.2)
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crass (1.0.6)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    loofah (2.9.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.1)
+    method_source (1.0.0)
+    mini_mime (1.0.3)
+    minitest (5.14.4)
+    nio4r (2.5.7)
+    nokogiri (1.11.3-x86_64-darwin)
+      racc (~> 1.4)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.3.1)
+      actioncable (= 6.1.3.1)
+      actionmailbox (= 6.1.3.1)
+      actionmailer (= 6.1.3.1)
+      actionpack (= 6.1.3.1)
+      actiontext (= 6.1.3.1)
+      actionview (= 6.1.3.1)
+      activejob (= 6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activerecord (= 6.1.3.1)
+      activestorage (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.3.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.1.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+    rake (13.0.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  auto_view_model!
+  minitest (~> 5.0)
+  rails (~> 6.1)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.2.14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Blake Williams
+
+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,81 @@
+# AutoViewModel
+
+Experimental gem to encapsulate existing partials via sidecar Ruby files.
+
+This gem doesn't replace partials, but instead builds on top of them:
+
+* Logic is encapsulated in a co-located Ruby file, not spread across helpers and external view model objects.
+* Partial arguments can be required.
+* Partial arguments can have default values, so no more `<%= my_value = "default" if !local_assigns.has_key?(:my_value) %>`
+
+## Installation
+
+1. Add `auto_view_model` to your Rails application's `Gemfile`.
+1. Run `bundle install`.
+1. In `config/application.rb`, add `require "auto_view_model/engine"`.
+1. Start adding Ruby files to your `views` directory.
+
+## Usage
+
+Using AutoViewModel is simple, create a Ruby file in the same directory as any
+partial with a matching name (sans `_` prefix).
+
+e.g.
+
+Given the template `app/views/posts/_post.html.erb`:
+
+```erb
+<h1><%= title.upcase %></h1>
+
+<p>
+  <%= markdown(body) %>
+</p>
+```
+
+You would create a sidecar Ruby file: `app/views/posts/post.rb`
+
+```ruby
+class Posts::Post < AutoViewModel::Base
+  requires :title # Raises if partial is not passed a title
+  accepts :body, default: "" # Allows default parameters for non-required attributes
+
+  def title
+    @title.upcase
+  end
+
+  def rendered_body
+    # Application and Rails provided helpers are usable in the view models
+    markdown(body)
+  end
+end
+```
+
+And update the template to use the `view` object:
+
+```erb
+<h1><%= view.title %></h1>
+
+<p>
+  <%= view.rendered_body %>
+</p>
+```
+
+To render the partial, use `render` like you would any other partial.
+
+```erb
+<%= render "posts/post", title: "Hello world", body: "Welcome!" %>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/BlakeWilliams/auto_view_model.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/auto_view_model.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/auto_view_model/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "auto_view_model"
+  spec.version       = AutoViewModel::VERSION
+  spec.authors       = ["Blake Williams"]
+  spec.email         = ["blake@blakewilliams.me"]
+
+  spec.summary       = "Automatic view models"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_dependency "activesupport", "~> 6.1"
+  spec.add_dependency "actionview", "~> 6.1"
+  spec.add_dependency "pry", "~> 0.14"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "auto_view_model"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/auto_view_model.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "action_view"
+require "active_support"
+
+require_relative "auto_view_model/version"
+require_relative "auto_view_model/base"
+
+module AutoViewModel
+  class Error < StandardError; end
+end

data/lib/auto_view_model/attributes.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module AutoViewModel
+  module Attributes
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_optional_attributes, default: {}
+      class_attribute :_required_attributes, default: Set.new
+    end
+
+    class_methods do
+      def requires(parameter)
+        _required_attributes << parameter
+
+        attr_reader parameter
+      end
+
+      def accepts(parameter, default: nil)
+        _optional_attributes[parameter] = default
+
+        attr_reader parameter
+      end
+
+      def inherited(subclass)
+        subclass._optional_attributes = _optional_attributes.dup
+        subclass._required_attributes = _required_attributes.dup
+        super
+      end
+    end
+
+    def initialize(locals)
+      _construct_attributes(locals)
+    end
+
+    private
+
+    def _construct_attributes(args)
+      _required_attributes.each do |attr|
+        if !args.has_key?(attr)
+          raise ArgumentError.new("Missing view keyword argument :#{attr}") # Simulate required kwargs
+        end
+
+        instance_variable_set("@#{attr}", args[attr])
+      end
+
+      _optional_attributes.each do |attr, default|
+        if args.has_key?(attr)
+          value = args[attr]
+          instance_variable_set("@#{attr}", value)
+        else
+          value = args[attr]
+          instance_variable_set("@#{attr}", default)
+        end
+      end
+    end
+  end
+end

data/lib/auto_view_model/base.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "attributes"
+
+module AutoViewModel
+  class Error < StandardError; end
+
+  class Base
+    include AutoViewModel::Attributes
+
+    def initialize(local_assigns, view_context:)
+      super(local_assigns)
+      @view_context = view_context
+    end
+
+    # View models should support helper methods available in
+    # the template. By delegating missing methods to view
+    # context, we can support all existing Rails and
+    # application defined helpers.
+    def method_missing(method, *args, &block)
+      if @view_context.respond_to?(method)
+        @view_context.public_send(method, *args, &block)
+      else
+        super
+      end
+    end
+    ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
+
+    def respond_to_missing?(method, include_all)
+      @view_context.respond_to?(method, include_all)
+    end
+  end
+end

data/lib/auto_view_model/engine.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rails"
+
+require_relative "template_patch"
+
+module AutoViewModel
+  class Engine < Rails::Engine
+    initializer :set_view_autoload_path, before: :set_load_path do |app|
+      app.config.autoload_paths += [app.root.join("app/views").to_s]
+    end
+
+    initializer "auto_view_model.monkey_patch" do |app|
+      ActiveSupport.on_load(:action_view) do
+
+        ActionView::Template.prepend(AutoViewModel::TemplatePatch)
+      end
+    end
+  end
+end

data/lib/auto_view_model/template_patch.rb

@@ -0,0 +1,13 @@
+
+module AutoViewModel
+  module TemplatePatch
+    def locals_code
+      class_name = virtual_path.classify
+      Object.const_get(class_name)
+
+      "view=#{class_name}.new(local_assigns, view_context: self);"
+    rescue NameError
+      super
+    end
+  end
+end

data/lib/auto_view_model/version.rb

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

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: auto_view_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Blake Williams
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description:
+email:
+- blake@blakewilliams.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- auto_view_model.gemspec
+- bin/console
+- bin/setup
+- lib/auto_view_model.rb
+- lib/auto_view_model/attributes.rb
+- lib/auto_view_model/base.rb
+- lib/auto_view_model/engine.rb
+- lib/auto_view_model/template_patch.rb
+- lib/auto_view_model/version.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Automatic view models
+test_files: []