rails-nm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28d5ade7ba4b58db524bb448069fdbb5e835219c52d1f6752a8d957579673846
+  data.tar.gz: c916a8f719b6ce6deaf3ea2a5b5cdecf5692ad068ab83304546dc11b4bc72905
+SHA512:
+  metadata.gz: 6c72873a32837fefa91df64a3b65b01ce16f6745d5605e10543e69cd173dc3959206e2a119711f60a64294c6ea53ff4337dbe44b32db9957bc268b332b7c5801
+  data.tar.gz: ffadba6668badcb01e0880ff4116673d4023f6aa74d16c84614fa5c836af1ab8b37ceafbadf441a19494a883c263e6d07f828d6e46f6b25a3a390ae868283429

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby "~> 2.5"
+
+gemspec
+
+gem "pry"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2021-Present Kelly Redding and Collin Redding
+
+MIT License
+
+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,29 @@
+# RailsNm
+
+Render `.json.nm` [Nm](https://github.com/redding/nm) templates in Rails.
+
+## Usage
+
+There is nothing to do other than add the gem to your Gemfile. You can then add .json.nm templates to your JSON resource actions in `app/views`. See https://github.com/redding/nm#nm for details on the Nm template syntax.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "rails-nm"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-nm
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Added some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/rails-nm.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "json"
+require "much-config"
+require "nm"
+require "rails-nm/version"
+
+module RailsNm
+  include MuchConfig
+
+  add_config
+
+  def self.source
+    @source ||= config.source
+  end
+
+  def self.encode(hash_or_array)
+    config.encoder.call(hash_or_array)
+  end
+
+  def self.render_content(
+        content,
+        template_identifier:,
+        context: Nm.default_context)
+    encode(
+      Nm::Context
+        .new(context, source: source, locals: config.locals.to_h)
+        .render_content(content, file_path: template_identifier),
+    )
+  end
+
+  class Config
+    attr_accessor :default_format, :extension, :locals, :encoder
+    attr_writer :views_path, :cache
+
+    def initialize
+      @default_format = :json
+      @extension = :nm
+      @locals = {}
+
+      @encoder = ->(hash_or_array){ ::JSON.dump(hash_or_array) }
+    end
+
+    def views_path
+      @views_path ||= ::Rails.root.join("app/views")
+    end
+
+    def cache
+      @cache = !::Rails.env.development? unless defined?(@cache)
+      @cache
+    end
+
+    def source
+      Nm::Source.new(
+        views_path,
+        cache: cache,
+        extension: extension,
+        locals: locals,
+      )
+    end
+  end
+end
+
+require "rails-nm/railtie" if defined?(::Rails)

data/lib/rails-nm/railtie.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require "rails-nm"
+require "rails-nm/template_handler"
+
+module RailsNm; end
+
+class RailsNm::Railtie < ::Rails::Railtie
+  initializer(:rails_nm) do
+    ::ActiveSupport.on_load(:action_view) do
+      ::ActionView::Template.register_template_handler(
+        RailsNm.config.extension,
+        ::RailsNm::TemplateHandler,
+      )
+    end
+  end
+end

data/lib/rails-nm/template_handler.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rails-nm"
+
+module RailsNm; end
+
+class RailsNm::TemplateHandler
+  cattr_accessor :default_format
+  self.default_format = RailsNm.config.default_format
+
+  def self.call(template, source = nil)
+    %{
+      RailsNm.render_content(
+        %{#{source || template.source}},
+        context: self,
+        template_identifier: "#{template.identifier}",
+      )
+    }
+  end
+end

data/lib/rails-nm/version.rb

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

data/rails-nm.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails-nm/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "rails-nm"
+  gem.version     = RailsNm::VERSION
+  gem.authors     = ["Kelly Redding", "Collin Redding"]
+  gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
+  gem.summary     = "Render .json.nm templates in Rails."
+  gem.description = "Render .json.nm templates in Rails."
+  gem.homepage    = "https://github.com/redding/rails-nm"
+  gem.license     = "MIT"
+
+  gem.files = `git ls-files | grep "^[^.]"`.split($INPUT_RECORD_SEPARATOR)
+
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = "~> 2.5"
+
+  gem.add_development_dependency("much-style-guide", ["~> 0.6.6"])
+  gem.add_development_dependency("assert",           ["~> 2.19.6"])
+  gem.add_development_dependency("rails",            ["> 5.0", "< 7.0"])
+
+  gem.add_dependency("nm",          ["~> 0.6.0"])
+  gem.add_dependency("much-config", ["~> 0.1.0"])
+end

data/test/helper.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# This file is automatically required when you run `assert`; put any test
+# helpers here.
+
+# Add the root dir to the load path.
+ROOT = Pathname.new(File.expand_path("../..", __FILE__))
+$LOAD_PATH.unshift(ROOT.to_s)
+
+TEST_SUPPORT_ROOT = ROOT.join("test/support")
+
+# Require pry for debugging (`binding.pry`).
+require "pry"
+
+require "test/support/factory"
+
+require "active_support"
+require "action_view"
+require "rails/version"
+
+def Rails.root
+  TEST_SUPPORT_ROOT
+end
+
+def Rails.env
+  @env ||= FakeEnv.new
+end
+
+class FakeEnv
+  def development?
+    true
+  end
+end
+
+require "rails-nm"
+require "rails-nm/template_handler"
+ActionView::Template.register_template_handler(:nm, RailsNm::TemplateHandler)
+
+require "test/support/test_action_view"
+
+class Assert::Context
+  private
+
+  def render(source, **locals)
+    TestActionView.render(source, **locals)
+  end
+end

data/test/support/app/views/users/user.json.nm

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+node "id", user.id
+node "firstName", user.first_name
+node "lastName", user.last_name

data/test/support/factory.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "assert/factory"
+
+module Factory
+  extend Assert::Factory
+end

data/test/support/test_action_view.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "action_view/testing/resolvers"
+
+module TestActionView
+  def self.render(source, **ivars)
+    JSON.parse(new(source, **ivars).render(template: "source"))
+  end
+
+  def self.new(source, **ivars)
+    resolver = ActionView::FixtureResolver.new({ "source.json.nm" => source })
+    lookup_context = ActionView::LookupContext.new([resolver], {}, [""])
+    controller = ActionView::TestCase::TestController.new
+
+    view =
+      ActionView::Base.with_empty_template_cache.new(
+        lookup_context,
+        ivars.to_h,
+        controller,
+      )
+    def view.view_cache_dependencies
+      []
+    end
+
+    view
+  end
+end

data/test/system/rails-nm_tests.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "assert"
+require "rails-nm"
+
+module RailsNm
+  class SystemTests < Assert::Context
+    desc "RailsNm"
+    subject{ RailsNm }
+  end
+
+  class RenderTests < SystemTests
+    desc "when rendering an Nm template in Rails"
+
+    let(:user_class){ Struct.new(:id, :first_name, :last_name) }
+    let(:users) do
+      Array.new(Factory.integer(3)) do
+        user_class.new(Factory.integer, Factory.string, Factory.string)
+      end
+    end
+
+    let(:template_source) do
+      <<~SOURCE
+        map @users do |user|
+          partial "users/user.json", :user => user
+        end
+      SOURCE
+    end
+
+    should "should render as expected" do
+      exp =
+        users.map do |user|
+          {
+            "id" => user.id,
+            "firstName" => user.first_name,
+            "lastName" => user.last_name,
+          }
+        end
+
+      assert_that(render(template_source, users: users)).equals(exp)
+    end
+  end
+end

data/test/unit/rails-nm_tests.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "assert"
+require "rails-nm"
+
+require "much-config"
+require "nm/source"
+
+module RailsNm
+  class UnitTests < Assert::Context
+    desc "RailsNm"
+    subject{ unit_module }
+
+    let(:unit_module){ RailsNm }
+
+    should have_imeths :source, :encode, :render_content
+
+    should "be configured as expected" do
+      assert_that(subject).includes(MuchConfig)
+      assert_that(subject.config).is_a(unit_module::Config)
+    end
+
+    should "know its attributes" do
+      assert_that(subject.source).equals(subject.config.source)
+    end
+
+    should "encode using the configured encoder" do
+      object = [{ key: "value" }, ["key", "value"]].sample
+      assert_that(subject.encode(object)).equals(JSON.dump(object))
+    end
+
+    # See test/system/rails-nm_tests.rb for system tests that test rendering
+    # template content.
+  end
+
+  class ConfigTests < UnitTests
+    desc "Config"
+    subject{ config_class }
+
+    let(:config_class){ unit_module::Config }
+  end
+
+  class ConfigInitTests < ConfigTests
+    desc "when init"
+    subject{ config_class.new }
+
+    should have_accessors :views_path, :default_format, :extension
+    should have_accessors :locals, :cache, :encoder
+    should have_imeths :source
+
+    should "know its attributes" do
+      assert_that(subject.views_path).equals(::Rails.root.join("app/views"))
+      assert_that(subject.default_format).equals(:json)
+      assert_that(subject.extension).equals(:nm)
+      assert_that(subject.locals).equals({})
+      assert_that(subject.cache).equals(!Rails.env.development?)
+      assert_that(subject.encoder).is_a(Proc)
+      assert_that(subject.source)
+        .equals(
+          Nm::Source.new(
+            subject.views_path,
+            cache: subject.cache,
+            extension: subject.extension,
+            locals: subject.locals,
+          ),
+        )
+    end
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: rails-nm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kelly Redding
+- Collin Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: much-style-guide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.6
+- !ruby/object:Gem::Dependency
+  name: assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.6
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: nm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: much-config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Render .json.nm templates in Rails.
+email:
+- kelly@kellyredding.com
+- collin.redding@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/rails-nm.rb
+- lib/rails-nm/railtie.rb
+- lib/rails-nm/template_handler.rb
+- lib/rails-nm/version.rb
+- log/.keep
+- rails-nm.gemspec
+- test/helper.rb
+- test/support/app/views/users/user.json.nm
+- test/support/factory.rb
+- test/support/test_action_view.rb
+- test/system/rails-nm_tests.rb
+- test/unit/rails-nm_tests.rb
+- tmp/.keep
+homepage: https://github.com/redding/rails-nm
+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.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Render .json.nm templates in Rails.
+test_files:
+- test/helper.rb
+- test/support/app/views/users/user.json.nm
+- test/support/factory.rb
+- test/support/test_action_view.rb
+- test/system/rails-nm_tests.rb
+- test/unit/rails-nm_tests.rb