actioncomponent 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76be070b5053ecc8da9c380f2e13946d9955b2dd3eeaa76f08d3dfe48031ea80
+  data.tar.gz: 48545e6160b1667d4af0fa0686bb60bb11130ee67d67a46686d1988ef25c7242
+SHA512:
+  metadata.gz: d04b7b700b5cb1a6fae38baa9a7bcaa5e4a7f1b65690de597ab599c8b3e514122f83830f0bc41bd985c7fea459e59f010e6b2a571bdcf4e935d155c03fb7ca29
+  data.tar.gz: 4b7a9dbc8c5f30951c1c1d2bd110cb277d291f591dc46dad8704f35c36b7f09f8d067e10b7fcd9ace15b441d45a42958ed4b3683c81d4781f2384fd8f4b12680

data/.codeclimate

@@ -0,0 +1,23 @@
+engines:
+  rubocop:
+    enabled: true
+    #checks:
+    #  Rubocop/Metrics/ClassLength:
+    #    enabled: false
+  brakeman:
+    enabled: false
+  eslint:
+    enabled: false
+  csslint:
+    enabled: false
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby:
+      - javascript:
+ratings:
+  paths:
+    - lib/**
+exclude_paths:
+  - spec/**/*

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/support/rails_app/log/*
+/tmp/
+.DS_Store
+.byebug_history
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_from: .rubocop_todo.yml
+
+Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 150
+  IgnoredPatterns: ['\A#']
+
+AllCops:
+  Exclude:
+    - actioncomponent.gemspec
+    - 'exe/**/*'
+    - 'bin/**/*'
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,26 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=3155042648b3cc74c8af8a1713df60818092046d8b395fdf29b4b1c00db7c792
+    - GIT_COMMITTED_AT=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then git log -1 --pretty=format:%ct; else git log -1 --skip 1 --pretty=format:%ct; fi)
+
+language: ruby
+
+cache:
+  bundler: true
+
+rvm:
+ - "2.4.1"
+
+bundler_args: "--binstubs --standalone --without documentation --path ../bundle"
+
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+
+script:
+  - bundle exec rubocop -c .rubocop.yml
+  - bundle exec rspec
+  - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT; fi
+
+notifications:
+  email: false

data/.yardopts

@@ -0,0 +1,3 @@
+--no-private
+--markup markdown
+--default-return void

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'yard', '~> 0.9.9', require: false
+
+# Specify your gem's dependencies in rabbitmq-spec.gemspec
+gemspec

data/README.md

@@ -0,0 +1,262 @@
+# Welcome to actioncomponent gem
+
+[![Travis](https://travis-ci.org/viniciusoyama/action_component.svg?branch=master)](https://travis-ci.org/viniciusoyama/action_component)
+[![Code Climate](https://codeclimate.com/github/viniciusoyama/action_component/badges/gpa.svg)](https://codeclimate.com/github/viniciusoyama/action_component)
+[![Test Coverage](https://codeclimate.com/github/viniciusoyama/action_component/badges/coverage.svg)](https://codeclimate.com/github/viniciusoyama/action_component)
+
+Frontend components for Ruby on Rails: group your view logic, html, css and javascript files in components to be used in views or directly rendered from controllers.
+
+# How to use?
+
+**Gemfile**
+```ruby
+gem 'actioncomponent'
+```
+
+# What do you get?
+
+## Organize your frontend code
+Your can group your frontend stuff by domain and organize the UI of your Rails app like this:
+
+```
+app
+├── components
+│   └── user
+│       └── filter
+│           └── template.html.erb
+│       └── list
+│           └── template.html.erb
+```
+
+
+And, in your views, or in your components, your can render it!
+
+**app/view/users/index.html.erb**
+
+```html
+<%
+  import_action_component 'Filter', path: 'user/filter'
+  import_action_component 'List', path: 'user/list'
+%>
+
+<%= Filter() %>
+
+<%= List(users: @users) %>
+```
+
+Or, you can completely drop your view and tell your controller to render a User Index Compoment
+
+```
+app
+├── components
+│   └── user
+│       └── filter
+│           └── template.html.erb
+│       └── list
+│           └── template.html.erb
+│       └── index
+│           └── template.html.erb
+```
+
+
+**app/components/user/index/template.html.erb**
+
+```html
+<%
+  import_action_component 'Filter', path: 'user/filter'
+  import_action_component 'List', path: 'user/list'
+%>
+
+<%= Filter() %>
+
+<%= List(users: @users) %>
+```
+
+**app/controllers/users_controller.rb**
+
+```ruby
+
+# ...
+# TODO
+# ...
+
+```
+
+## Pass data to your components
+
+When rendering your can pass data in a hash/named parameters format. The data will be exposed in your template through a view model.  
+
+Supose that you have a header component
+
+```
+app
+├── components
+│   └── header
+│       └── template.html.erb
+```
+
+And you want to render this component in your layout file.
+
+**app/views/layouts/application.html.erb**
+
+```html
+
+<%
+  import_action_component 'Header', path: 'header'
+%>
+
+<%= Header(my_user: current_user) %>
+```
+
+You can access the user attribute in your template like this:
+
+**app/components/header/template.html.erb**
+
+```html
+<header>
+  Hi, <%= my_user.name %>
+</header>
+```
+
+## View Models
+
+The methods available inside the template will be those defined in your view model. If no view model is defined for your component then our ActionComponent::Component::ViewModel will be used. The view model is instantiated with the arguments that you provide when calling your component.
+
+### ActionComponent::Component::ViewModel
+
+It takes all the constructor arguments (it must be a hash/named args) and creates a getter for each one of them. Example:
+
+```ruby
+vm = ActionComponent::Component::ViewModel.new(name: 'John', age: 12)
+vm.name # John
+vm.age # 12
+```
+
+### Create your own ViewModel: handle complex view logic
+
+We only use our own view model if there is no view_model.rb file inside your component's folder. This file should declare a class following all the Rails naming conventions.
+
+So, imagine that we want our vm to have a random_greeting method. We can can create a view model like this:
+
+
+## Use helpers inside your components
+
+When initializing the view model we also provide two additionals parameters (:h and :helper) so you can have access to rails helpers.
+
+As all view model methods are available to your template your will have access to a `h` or `helper` like this:
+
+**Example of a component's templatefile**
+
+```
+<div class="child">
+  <div class="date">
+    <%= helper.l(Date.new(2019, 01, 03)) %>
+  </div>
+
+  <div class="routes">
+    <%= h.users_path %>
+  </div>
+
+  <div class="translation">
+    <%= h.t('hello')%>
+  </div>
+</div>
+```
+
+Your can create custom view models that inherits from ours
+
+**app/components/header/view_model.rb**
+
+```ruby
+class Header::ViewModel < ActionComponent::Component::ViewModel
+  def random_greeting
+    hi_text = ['Hi', 'Yo'].sample
+    "#{hi_text}, #{user.name}"
+  end
+end
+```
+
+Now the template can access the method like this:
+
+**app/components/header/template.html.erb**
+```html
+<header>
+  <%= random_greeting %>
+</header>
+```
+
+### Use helpers inside a ViewModel
+
+A `helper` and `h` attribute are passed when instantiating a ViewModel.
+
+```ruby
+class Header::ViewModel < ActionComponent::Component::ViewModel
+  def random_greeting
+    hi_text = ['Hi', 'Yo'].sample
+    "#{hi_text}, #{user.name}."
+  end
+
+  def formated_date
+    h.l(Date.today)
+  end
+end
+```
+
+**app/components/header/template.html.erb**
+```html
+<header>
+  <%= random_greeting %> Today is <%= formated_date %>
+</header>
+```
+
+
+## Access your controller in your VM or Template
+
+When rendering a component, a `c` or `controller` parameter is passed through so you can have access to all your request data inside your VM or template.
+
+**view_model**
+
+```ruby
+class ControllerData::ViewModel < ActionComponent::Component::ViewModel
+
+  def formated_page
+    "Current page: #{c.params[:page]}"
+  end
+
+  def formated_search
+    "Searching for: #{controller.params[:search]}"
+  end
+
+end
+```
+
+**template.erb**
+
+```html
+<%= formated_search %>
+
+<%= formated_page %>
+```
+
+
+# Configuration
+
+You can change some parameters by creating a initializer on your app
+
+**config/initializers/action_component.rb**
+
+
+```ruby
+
+ActionComponent.configure do |config|
+  # Folder path to look for components
+  config.components_path = 'app/components'
+
+  # Default name for the html/erb/slim/etc template file inside the component folder
+  config.template_file_name = 'template'
+
+  # Default name for the view model file inside the component folder
+  config.view_model_file_name = 'view_model'
+end
+
+```

data/actioncomponent.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.name        = 'actioncomponent'
+  s.version     = '0.1.1'
+  s.date        = '2019-03-21'
+  s.summary     = 'Stop using views: frontend components architecture for Ruby on Rails'
+  s.description = 'Stop using views: frontend components architecture for Ruby on Rails'
+  s.authors     = ['Vinícius Oyama']
+  s.email       = 'contact@viniciusoyama.com'
+  s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.homepage    =
+    'http://rubygems.org/gems/actioncomponent'
+  s.license = 'MIT'
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_dependency 'rails', '>= 4.0.0'
+
+  # Quality Control
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
+
+  # Debugging
+  s.add_development_dependency 'awesome_print'
+  s.add_development_dependency 'pry-byebug'
+
+  # for testing a gem with a rails app (controller specs)
+  # https://codingdaily.wordpress.com/2011/01/14/test-a-gem-with-the-rails-3-stack/
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'rails', '> 4.0'
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'sqlite3'
+end

data/lib/actioncomponent/component/renderer.rb

@@ -0,0 +1,24 @@
+module ActionComponent
+  # Renders a given component
+  class Component
+    class Renderer < ActionView::Renderer
+      class ComponentTemplateFileNotFound < StandardError; end
+
+      attr_reader :view_model
+
+      def initialize(lookup_context, view_model)
+        @lookup_context = lookup_context
+        @view_model = view_model
+      end
+
+      def render(component_path:)
+        file_path = template_path_from_component_path(component_path)
+        super(view_model, file: file_path)
+      end
+
+      def template_path_from_component_path(component_path, template_file_name: ActionComponent.configuration.template_file_name)
+        File.join(component_path, template_file_name).to_s
+      end
+    end
+  end
+end

data/lib/actioncomponent/component/view_model.rb

@@ -0,0 +1,22 @@
+module ActionComponent
+  # Renders a given component
+  class Component
+    class ViewModel
+      include ActionComponent::ImporterHelper
+
+      def initialize(**args)
+        generate_methods_from_hash(args)
+      end
+
+      private
+
+      def generate_methods_from_hash(hash)
+        hash.each do |key, val|
+          define_singleton_method key.to_sym do
+            val
+          end
+        end
+      end
+    end
+  end
+end

data/lib/actioncomponent/component.rb

@@ -0,0 +1,81 @@
+module ActionComponent
+  # Represents a component with a template, style and javascript file
+  class Component
+    class InvalidVMError < StandardError; end
+    class << self
+      def helper_object
+        @helper_object = Class.new(ActionView::Base) do
+          include ::Rails.application.routes.url_helpers
+          include ::Rails.application.routes.mounted_helpers
+        end.new
+      end
+
+      def helper_vm_params
+        {
+          h: helper_object,
+          helper: helper_object
+        }
+      end
+    end
+
+    attr_reader :view_model_data, :component_path
+
+    def initialize(component_path:, lookup_context: nil, view_model_data: {})
+      @component_path = component_path.to_s.gsub(%r{^/}, '')
+      @lookup_context = lookup_context
+      @view_model_data = view_model_data
+    end
+
+    def render
+      renderer.render(component_path: @component_path)
+    end
+
+    def renderer
+      ActionComponent::Component::Renderer.new(lookup_context, create_view_model)
+    end
+
+    def lookup_context
+      @lookup_context ||= ActionView::LookupContext.new(
+        [
+          full_component_path
+        ]
+      )
+    end
+
+    def create_view_model
+      vm_class = ActionComponent::Component::ViewModel
+
+      begin
+        vm_class = find_custom_vm_class!
+      rescue NameError
+        vm_class = ActionComponent::Component::ViewModel
+      end
+
+      vm_class.new(**view_model_data.merge(view_model_default_data))
+    end
+
+    def view_model_default_data
+      # lookup_context is necessary for when there is an exception in our template
+      # this is used in order to better describe the error stack
+      self.class.helper_vm_params.merge(lookup_context: lookup_context)
+    end
+
+    def full_component_path
+      Rails.root.join(ActionComponent.configuration.components_path)
+    end
+
+    private
+
+    def find_custom_vm_class!
+      vm_file_path = Pathname.new(component_path).join(ActionComponent.configuration.view_model_file_name)
+      vm_class = ActiveSupport::Inflector.camelize(vm_file_path).constantize
+
+      unless vm_class.ancestors.include?(ActionComponent::Component::ViewModel)
+        error_msg = "#{vm_class} cannot be used as a ViewModel. Make sure that it inherits from ActionComponent::Component::ViewModel."
+        raise ActionComponent::Component::InvalidVMError, error_msg
+      end
+
+      vm_class
+    end
+  end
+end

data/lib/actioncomponent/importer_helper.rb

@@ -0,0 +1,25 @@
+module ActionComponent
+  # Exposes component rendering methods to Rails views
+
+  module ImporterHelper
+    # Description of #import_action_component
+    #
+    # @param local_component_name [String] Local's component name (in the view scope)
+    # @param opts [Hash] default: {} Options.
+    # @example
+    def import_action_component(local_component_name, opts = {})
+      raise "No path informed when importing component #{local_component_name}" if opts[:path].blank?
+
+      define_singleton_method(local_component_name) do |**args|
+        create_component(opts[:path], args).render
+      end
+    end
+
+    def create_component(component_path, view_model_data)
+      ActionComponent::Component.new(
+        component_path: component_path,
+        view_model_data: view_model_data.merge(c: controller, controller: controller)
+      )
+    end
+  end
+end

data/lib/actioncomponent/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails/railtie'
+
+class ViewComponent
+  class Rails < Rails::Railtie
+    config.view_component = ActiveSupport::OrderedOptions.new
+
+    initializer 'view_component' do
+      ::ActionView::Base.send(:include, ActionComponent::ImporterHelper)
+    end
+  end
+end

data/lib/actioncomponent.rb

@@ -0,0 +1,30 @@
+require 'actioncomponent/importer_helper'
+require 'actioncomponent/component'
+require 'actioncomponent/component/view_model'
+require 'actioncomponent/component/renderer'
+require 'actioncomponent/railtie'
+
+module ActionComponent
+  # Configuration class for ActionComponent
+  # @attr components_path [String] Components folder path (defaults to 'app/components')
+  # @attr components_path [String] Component's template file name (defaults to 'template')
+  class Configuration
+    attr_accessor :components_path
+    attr_accessor :template_file_name
+    attr_accessor :view_model_file_name
+
+    def initialize
+      @components_path = 'app/components'
+      @template_file_name = 'template'
+      @view_model_file_name = 'view_model'
+    end
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: actioncomponent
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Vinícius Oyama
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rubocop
+  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: simplecov
+  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: awesome_print
+  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: pry-byebug
+  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: bundler
+  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: capybara
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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: 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'
+description: 'Stop using views: frontend components architecture for Ruby on Rails'
+email: contact@viniciusoyama.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- README.md
+- actioncomponent.gemspec
+- lib/actioncomponent.rb
+- lib/actioncomponent/component.rb
+- lib/actioncomponent/component/renderer.rb
+- lib/actioncomponent/component/view_model.rb
+- lib/actioncomponent/importer_helper.rb
+- lib/actioncomponent/railtie.rb
+homepage: http://rubygems.org/gems/actioncomponent
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: 'Stop using views: frontend components architecture for Ruby on Rails'
+test_files: []