daylight 0.9.0.rc1

data/rails/extensions/render_json_meta.rb

@@ -0,0 +1,99 @@
+module RenderJsonMeta
+  extend ActiveSupport::Concern
+
+  included do
+    ##
+    # Hooks into ActiveModelSerializer's ActionController::Serialization `_render_option_json` method
+    def _render_option_json(resource, options)
+      # All modules that are included will be able to add to the metadata hash
+      metadata = (options[:meta] || {}).tap do |metadata|
+        _add_metadata(resource, metadata)
+      end
+      options[:meta] = metadata unless metadata.blank?
+
+      super
+    end
+  end
+
+
+  ##
+  # Default metadata method (a no-op) that does not call `super`
+  module MetadataDefault
+    def _add_metadata(resource, metadata); end
+  end
+
+  ##
+  # For AssociationRelations, add known `where_values_hash` to the meta data
+  module MetadataWhereValues
+    def _add_metadata(resource, metadata)
+      if ActiveRecord::AssociationRelation === resource && resource.respond_to?(:where_values_hash)
+        metadata[:where_values] = resource.where_values_hash
+      end
+
+      super
+    end
+  end
+
+  ##
+  # For AssociationRelations, add known `nested_resource_names` to the meta data
+  module MetadataNestedResources
+    def _add_metadata(resource, metadata)
+      _collect_metadata(:nested_resources, resource, metadata) do |model|
+        model.class.nested_resource_names if model.class.respond_to?(:nested_resource_names)
+      end
+
+      super
+    end
+  end
+
+  ##
+  # Adds `read_only` attributes from the serializer of the resource, or traverse
+  # the AssociationRelation/Relation for each one of the collection's `read_only` attributes
+  module MetadataReadOnly
+    def _add_metadata(resource, metadata)
+      _collect_metadata(:read_only, resource, metadata) do |model|
+
+        serializer = model.try(:active_model_serializer)
+        if serializer.respond_to?(:read_only)
+          serializer._read_only if serializer.read_only
+        end
+      end
+
+      super
+    end
+  end
+
+  private
+    def _collect_metadata(key, resource, metadata, &block)
+      if ActiveRecord::AssociationRelation === resource || ActiveRecord::Relation === resource
+        resource.each { |model| _assign_metadata(key, model, metadata, &block) }
+      else
+        _assign_metadata(key, resource, metadata, &block)
+      end
+    end
+
+    def _assign_metadata(attribute_key, resource, metadata)
+      class_key = resource.class.name.underscore
+
+      # quick return if attribute is already computed
+      return if metadata[class_key] && metadata[class_key][attribute_key]
+
+      if results = yield(resource)
+        metadata[class_key] ||= {}
+        metadata[class_key].merge!({ attribute_key => results })
+      end
+    end
+end
+
+# Hook all of the RenderJsonMeta modules into ActionController
+# Each module will be chained together on the `_add_meta_data` method.
+ActiveSupport.on_load(:action_controller) do
+  include ::RenderJsonMeta
+
+  # Modules could not be included within the concern, likely
+  # because the context is lost from her in the on_load block
+  include ::RenderJsonMeta::MetadataDefault
+  include ::RenderJsonMeta::MetadataWhereValues
+  include ::RenderJsonMeta::MetadataNestedResources
+  include ::RenderJsonMeta::MetadataReadOnly
+end

data/rails/extensions/route_options.rb

@@ -0,0 +1,47 @@
+##
+# Support for :associated and :methods options on resource routes
+#
+# :associated specifies which assocations are supported by the resource
+# :remoted    specifies which remote methods are supported by the resource
+module RouteOptions
+  extend ActiveSupport::Concern
+
+  included do
+    def set_member_mappings_for_resource
+      super
+
+      associated = parent_resource.options[:associated] || []
+      remoted    = parent_resource.options[:remoted]    || []
+
+      member do
+        associated.each do |association|
+          get association, to: "#{parent_resource.plural}#associated", defaults: {associated: association}, as: association
+        end
+
+        remoted_model = get_remoted_model
+        remoted.each do |remote|
+          remoted_model.add_remoted(remote) if remoted_model
+          get remote, to: "#{parent_resource.name}#remoted", defaults: {remoted: remote}, as: remote
+        end
+
+      end
+
+    end
+
+    def get_remoted_model
+      controller = "#{parent_resource.name}_controller".classify.constantize rescue nil
+      controller && controller.respond_to?(:model) ? controller.send(:model) : parent_resource.name.classify.constantize
+    rescue
+      Rails.logger.warn "Could not lookup model for #{parent_resource.name} to apply remoted."
+    end
+
+  end
+end
+
+ActionDispatch::Routing::Mapper.class_eval do
+  include RouteOptions
+
+  # need to support the associated and :remoted resource options
+  self::Resources::RESOURCE_OPTIONS << :associated
+  self::Resources::RESOURCE_OPTIONS << :remoted
+end

data/rails/extensions/versioned_url_for.rb

@@ -0,0 +1,22 @@
+module VersionedUrlFor
+  extend ActiveSupport::Concern
+
+  included do
+    def url_for options={}
+      super(options.respond_to?(:to_model) ? versioned_url_for(options) : options)
+    end
+
+    protected
+      def versioned_url_for model
+        send(versioned_path, model)
+      end
+
+      def versioned_path
+        "#{versioned_name}_path"
+      end
+
+      def versioned_name
+        controller_path.gsub('/', '_').singularize
+      end
+  end
+end

data/spec/config/dependencies.rb

@@ -0,0 +1,2 @@
+require 'factory_girl'
+require 'faker'

data/spec/config/factory_girl.rb

@@ -0,0 +1,4 @@
+RSpec.configure do |config|
+  # to get the fancy FactoryGirl loading syntatic sugar
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/config/simplecov_rcov.rb

@@ -0,0 +1,26 @@
+if %w[COVERAGE JENKINS_URL].any? { |switch| ENV.keys.include? switch }
+
+  require 'simplecov'
+  require 'simplecov-rcov'
+
+  class SimpleCov::Formatter::MergedFormatter
+    def format(result)
+       SimpleCov::Formatter::HTMLFormatter.new.format(result)
+       SimpleCov::Formatter::RcovFormatter.new.format(result)
+    end
+  end
+  SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+
+  SimpleCov.profiles.define 'api' do
+    load_profile 'test_frameworks'
+
+    add_group 'Client API', 'lib/daylight'
+    add_group 'Server API', 'rails/daylight'
+    add_group 'Rails Exts', 'rails/extensions'
+    add_group 'Doc Engine', 'app'
+
+    add_filter '/config/'
+  end
+
+  SimpleCov.start 'api'
+end

data/spec/config/test_api.rb

@@ -0,0 +1 @@
+Daylight::API.setup! namespace: 'test_api', password: 'test', endpoint: 'http://daylight.test', version: 'v1'

data/spec/controllers/documentation_controller_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe DaylightDocumentation::DocumentationController do
+
+  class TestModel < ActiveRecord::Base
+  end
+
+  it "renders an index" do
+    get :index, :use_route => :daylight
+
+    assert_response :success
+
+    assigns[:models].should include(TestModel)
+  end
+
+  it "renders a model view" do
+    get :model, model: 'test_model', :use_route => :daylight
+
+    assert_response :success
+
+    assigns[:model].should == TestModel
+  end
+
+end

data/spec/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/spec/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/spec/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/spec/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/spec/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/spec/dummy/app/helpers/application_helper.rb

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

data/spec/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/spec/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/spec/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/spec/dummy/bin/rake

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

data/spec/dummy/config/application.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+
+require 'daylight/documentation'
+
+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/spec/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/spec/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/spec/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/spec/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/spec/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

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

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/daylight.rb

@@ -0,0 +1 @@
+require 'daylight/server'

data/spec/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,12 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure your secret_key_base is kept private
+# if you're sharing your code publicly.
+Dummy::Application.config.secret_key_base = '025414badf185c94787eb71ccb96687aca39e041da85ba0863ce4e687b93f30e09e595887fd6c877e9929a137f409ef91d8fb73db1e6ca8057d14437d87c0749'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1,3 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json] if respond_to?(:wrap_parameters)
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#  self.include_root_in_json = true
+# end