active-component 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84ffbaab593ec37dd371476f2559e622c3bbb93d
+  data.tar.gz: 1e05282ae2b9a877170681baacad3de333bb5099
+SHA512:
+  metadata.gz: 8b89277ebf14d589ff5ef1bacb1f371ba2cc4de119c27535e43d270fd8ff7e4e54b00e8e1a0bb138de5ba622bb001f5dfdb07f3497fef80dc1cb01860cd0e581
+  data.tar.gz: 86810e54af102cd43b1e4441d65b9030735040117b23fc5fcb0493bbc0996824f704e6c8b6232edeec6283a58c21c1654c2e8ef31d40a9f16357a24d5486091e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Antonio Chávez
+
+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/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveComponent'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/active_component/base.rb

@@ -0,0 +1,55 @@
+require 'mustache'
+
+module ActiveComponent
+  #
+  # We inherit from mustache to have a default template engine 
+  # for the application, we might add more templating options in the 
+  # future.
+  #
+  class Base < Mustache
+    #
+    # We're going to eventually add the view helpers to this side of
+    # the application in order to allow this class to interact with
+    # the rails conventions, especially with the asset pipeline.
+    #
+    include ActionView::Helpers::DateHelper
+    #
+    # Whenever the user creates a new object from a class inherited
+    # from ActiveComponent::Base it needs to define its attributes as
+    # `attr_accessor :var` in order to be able to initialize the object
+    # with specific values.
+    #
+    # class ViewComponent < ActiveComponent::Base
+    #   attr_accessor :var
+    # end
+    #
+    # The values shall be provided as hash, active component automatically
+    # will know who's going to receive the value otherwise raise an error.
+    #
+    # component = ViewComponent.new(var: var)
+    #
+    # In addition to this we provide the controller context from where the
+    # view component is called.
+    # 
+    # self.controller from anywhere in the inherited classes.
+    #
+    def initialize(args = {})
+      if args.kind_of? Hash
+        assign_variables args
+        @controller = ActiveComponent.get_controller rescue nil
+      else
+        raise ArgumentError, "Expected: Hash. Received: #{args.class.name}"
+      end
+    end
+
+    def assign_variables(args)
+      args.each do |key, value|
+        self.send("#{key}=", value)
+      end
+    end
+
+    def controller
+      @controller
+    end
+  end
+end

data/lib/active_component/context.rb

@@ -0,0 +1,39 @@
+#
+# This is an autoincluded module for ActionController::Base
+# 
+# It will store the controller context for the given request in a
+# @@controllers hash.
+#
+# It was necessary to remove the controller instance from the
+# @@controllers hash manually using ObjectSpace to prevent memory
+# leaks in the server.
+#
+# You can call ActiveComponent.get_controller from anywhere in the 
+# application.
+#
+module ActiveComponent
+  @@controller = {}
+
+  class << self
+    def get_controller
+      @@controller[Thread.current.object_id]
+    end
+
+    def set_controller(controller)
+      @@controller[Thread.current.object_id] = controller
+      ObjectSpace.define_finalizer Thread.current, -> (id){ @@controller[id].delete! }
+    end
+  end
+
+  module Context
+
+    def self.included(base)
+      base.before_filter(:get_context)
+    end
+
+    def get_context
+      ActiveComponent.set_controller(self)
+    end
+
+  end
+end

data/lib/active_component/railtie.rb

@@ -0,0 +1,13 @@
+#
+# Autoinclude some of the modules from the controller top level
+#
+module ActiveComponent
+  class Railtie < Rails::Railtie
+    initializer "Appends a method to the action controller class" do
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.send(:include, ActiveComponent::Context)
+        ActionController::Base.send(:include, ActiveComponent::Renderable)
+      end
+    end
+  end
+end

data/lib/active_component/renderable.rb

@@ -0,0 +1,20 @@
+require 'active_support/concern'
+
+# 
+# Work In Progress
+#
+# The idea is to provide a clean rails-like methods to
+# render view components nicely from the view or even respond
+# with them from a controller instance
+#
+# render_component(:view_component, var: var)
+#
+module ActiveComponent
+  module Renderable
+    extend ActiveSupport::Concern
+
+    def render_component
+      ""
+    end
+  end
+end

data/lib/active_component/version.rb

@@ -0,0 +1,3 @@
+module ActiveComponent
+  VERSION = "0.0.1"
+end

data/lib/active_component.rb

@@ -0,0 +1,7 @@
+require 'active_component/base'
+require 'active_component/renderable'
+require 'active_component/context'
+require 'active_component/railtie' if defined?(Rails)
+
+module ActiveComponent
+end

data/lib/generators/component_generator.rb

@@ -0,0 +1,11 @@
+class ComponentGenerator < Rails::Generators::NamedBase
+  self.source_root File.expand_path("../templates", __FILE__)
+  
+  desc "Creates view component"
+  
+  def create_component
+    copy_file   "application_component.rb", "app/components/application_component.rb"
+    template    "component.rb", "app/components/#{file_name}_component.rb"
+    create_file "app/templates/#{file_name}_component.mustache"
+  end
+end

data/lib/generators/templates/application_component.rb

@@ -0,0 +1,5 @@
+class ApplicationComponent < ActiveComponent::Base
+  #
+  # Add your component overrides here
+  #
+end

data/lib/generators/templates/component.rb

@@ -0,0 +1,6 @@
+class <%= file_name.camelize %>Component < ApplicationComponent
+
+  # NOTICE: Do not remove this line this references the template path for the actual component
+  self.template_path = File.dirname("#{Rails.root}/app/templates/#{self.class.name.underscore}")
+
+end

data/lib/tasks/active_component_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :active_component do
+#   # Task goes here
+# end

data/test/active_component/base_test.rb

@@ -0,0 +1,30 @@
+require 'test_helper'
+
+class ActiveComponent::BaseTest < ActiveSupport::TestCase
+
+  setup do
+    FooController.new.get_context
+    @foo = Foo.new(bar: "bar")
+  end
+
+  test "has included date helper from action view" do
+    assert @foo.distance_of_time_in_words_to_now(1.day.ago)
+  end
+
+  test "a new instance of active_component/base accepts only a hash of arguments" do
+    assert_nothing_raised(ArgumentError, nil) { Foo.new(bar: Faker::Name.name) }
+  end
+
+  test "a new instance of active component should raise an error if the given value is not a hash" do
+    assert_raise(ArgumentError, nil) { Foo.new(Faker::Lorem.sentence) }
+  end
+  
+  test "assigns the values to instance variables" do
+    assert_equal @foo.bar, "bar"
+  end
+
+  test "sets controller for the component context" do
+    assert_kind_of FooController, @foo.controller
+  end
+
+end

data/test/active_component/context_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class ActiveComponent::ContextTest < ActiveSupport::TestCase
+
+  test "returns a cotroller instance" do
+    FooController.new.get_context
+    assert_kind_of FooController, ActiveComponent.get_controller
+  end
+
+end

data/test/active_component/railtie_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class ActiveComponent::RailtieTest < ActiveSupport::TestCase
+
+  test "get the controller context" do
+    assert FooController.new.render_component
+  end
+
+end

data/test/active_component/renderable_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class ActiveComponent::RenderableTest < ActiveSupport::TestCase
+
+  test "renders a component" do
+    assert_kind_of(String, FooController.new.render_component)
+  end
+
+end

data/test/active_component_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class ActiveComponentTest < ActiveSupport::TestCase
+
+  test "has a get controller method" do
+    assert ActiveComponent.get_controller
+  end
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/components/application_component.rb

@@ -0,0 +1,5 @@
+class ApplicationComponent < ActiveComponent::Base
+  #
+  # Add your component overrides here
+  #
+end

data/test/dummy/app/components/dummy_component.rb

@@ -0,0 +1,6 @@
+class DummyComponent < ApplicationComponent
+
+  # NOTICE: Do not remove this line this references the template path for the actual component
+  self.template_path = File.dirname("#{Rails.root}/app/templates/#{self.class.name.underscore}")
+
+end

data/test/dummy/app/components/message_component.rb

@@ -0,0 +1,10 @@
+class MessageComponent < ApplicationComponent
+
+  # NOTICE: Do not remove this line this references the template path for the actual component
+  self.template_path = File.dirname("#{Rails.root}/app/templates/#{self.class.name.underscore}")
+
+  def tuculo
+    "#{controller.methods}"
+  end
+
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/templates/message_component.mustache

@@ -0,0 +1 @@
+{{ tuculo }}

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "active_component"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end