maskara 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 312ad3120985a3b155234751c812c546877f7c32
+  data.tar.gz: 095b5ba4d5fc4f0be2f43d883e4f0993209c42b1
+SHA512:
+  metadata.gz: 1d815270f0ac3935cabeb4830d0ca220e042dae24ed5e1cadfb11dd35730513ac5cb3511dd3663cd7ece3921a00240d19c6585ab02e593dfbbae4ab1915ebecc
+  data.tar.gz: 8b4585e19742398ea7cb993794f9243ad283ad2bed0e9b05500413a52302ce651f23dfec63def293e97c23f6ed2e1fba7b4dc27b38f997d0951ca1eaf340213c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/spec/dummy/tmp/*
+/spec/dummy/log/*
+*.gem

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+maskara

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in maskara.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Fairfax Media
+
+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,67 @@
+# Maskara
+
+Maskara is designed to take the pain out of frontend development (primarily for Rails, but it tries to be platform agnostic.)
+
+It encourages developers and frontend designers to collaboratively mock out actions with fixture data, and then to use special URLs to access those actions - this allows easier testing of heavy (or incomplete) actions, and quick prototyping, with the entire Rails view stack still available.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'maskara'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install maskara
+
+
+## Usage
+
+Generate a default YAML fixture file with the rake command:
+
+```
+rake maskara:generate
+```
+
+(The file defaults to RAILS_ROOT/db/fixtures/maskara.yml)
+
+Edit the file with information about the objects your template needs (and filters you wish to disable). ([The example in the test directory](spec/dummy/db/fixtures/maskara.yml) demonstrates the sort of options that are available.)
+
+Maskara can use Rack middleware to identify maskara requests (this is the easiest way to employ it) so here's how you include it in your application.rb:
+
+```
+config.middleware.insert_after Rails::Rack::Logger, Maskara::Middleware
+```
+
+Then, after restarting Rails, prepend `/maskara/` to the path you'd normally use to access the view: eg.
+
+```http://localhost:3000/member/edit/1```
+
+would become...
+
+```http://localhost:3000/maskara/member/edit/1```
+
+Instead of running the controller action, the data form the fixture file should be loaded into the controller and a normal render call executed.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://bitbucket.org/simon_hildebrandt/maskara.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rails/dummy/tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "maskara"
+
+# 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

data/bin/setup

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

data/lib/maskara.rb

@@ -0,0 +1,41 @@
+require "maskara/data"
+require "maskara/middleware"
+require "maskara/version"
+
+require 'maskara/railtie' if defined?(Rails)
+
+module Maskara
+  class Configuration
+    attr_accessor :data_path
+
+    def data_path
+      @data_path or fail NotConfiguredError.new("Maskara needs to be configured with a data_path to find #{data_file_name}")
+    end
+
+    def data_file
+      File.join(data_path, data_file_name)
+    end
+
+    def data_file_name
+      'maskara.yml'
+    end
+  end
+  
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def path_stub
+      'maskara'
+    end
+  end
+
+  class NotConfiguredError < StandardError; end
+end

data/lib/maskara/data.rb

@@ -0,0 +1,44 @@
+module Maskara
+  class Data
+    class << self
+      def data_file
+        Maskara.configuration.data_file
+      end
+
+      def data
+        @data ||= load_data || {}
+      end
+
+      def load_data
+        begin
+          return YAML.load(open(data_file).read)
+        rescue Errno::ENOENT
+          puts "Coundn't find Maskara data file at #{data_file}"
+        rescue Psych::SyntaxError
+          puts "Invalid YAML found in Maskara data file at #{data_file}"
+        end
+        {}
+      end
+
+      def controllers_data
+        data.fetch('controllers', {})
+      end
+
+      def controller_data(controller)
+        controllers_data.fetch(controller, {})
+      end
+
+      def action_data(action, controller)
+        controller_data(controller).fetch('actions', {}).fetch(action, {})
+      end
+
+      def skip_filters
+        controllers_data.collect do |controller, config|
+          unless config['skip_filters'].blank?
+            ["#{controller.classify}Controller".constantize, config['skip_filters'].map(&:to_sym)]
+          end
+        end.compact
+      end
+    end
+  end
+end

data/lib/maskara/generator.rb

@@ -0,0 +1,59 @@
+module Maskara
+  class Generator
+    class << self
+      def run
+        fail("#{data_file} already exists.") if File.exists?(data_file)
+
+        # In development Rails doesn't load controllers until they're referenced
+        eager_load_controllers
+        write_example_data_file
+      end
+
+      private
+
+      def data_file
+        Maskara.configuration.data_file
+      end
+
+      def write_example_data_file
+        FileUtils.mkdir_p(Maskara.configuration.data_path)
+
+        File.open(data_file, 'w') do |file|
+          YAML.dump(clean_controller_data, file)
+        end
+      end
+
+      def clean_controller_data
+        { 'controllers' => dump_controllers }
+      end
+
+      def dump_controllers
+        Hash[ controller_list ]
+      end
+
+      def controller_list
+        ActionController::Base.descendants.collect do |controller|
+          catch(:empty_controller) do
+            [ controller.controller_path, action_data(controller) ]
+          end
+        end.compact
+      end
+
+      def action_data(controller)
+         { 'actions' => Hash[ action_list(controller) ] }
+      end
+
+      def action_list(controller)
+        throw :empty_controller if controller.action_methods.empty?
+
+        controller.action_methods.to_a.collect{ |action| [ action, {} ] }
+      end
+
+      def eager_load_controllers
+        Dir.glob(Rails.root.join "app/controllers/**/*_controller.rb").each do |file|
+          require_dependency file
+        end
+      end
+    end
+  end
+end

data/lib/maskara/middleware.rb

@@ -0,0 +1,35 @@
+module Maskara
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      new_env = env
+      if maskara_path? env['PATH_INFO']
+        log "Maskara path: #{env['PATH_INFO']}"
+        new_env = env.dup
+        new_env['MASKARA_REQUEST'] = true
+        new_env['REQUEST_URI'] = new_env['PATH_INFO'] = env['PATH_INFO'].sub(maskara_regex, '/')
+        new_env['REQUEST_URI'] += "?#{env['QUERY_STRING']}" unless env['QUERY_STRING'].nil? || env['QUERY_STRING'].empty?
+      end
+      @app.call(new_env)
+    end
+
+    def maskara_path? path
+      path =~ maskara_regex
+    end
+
+    def maskara_regex
+      /\A(\/#{Maskara.path_stub}\/)/
+    end
+
+    def log msg
+      if (defined? Rails)
+        Rails.logger.debug msg
+      else
+        puts msg
+      end
+    end
+  end
+end

data/lib/maskara/railtie.rb

@@ -0,0 +1,67 @@
+require 'recursive-open-struct'
+require 'maskara/generator'
+require 'maskara/data'
+
+# Support adding /maskara into generated routes
+if Rails::VERSION::MAJOR >= 4
+  module ActionDispatch::Routing
+    class RouteSet::NamedRouteCollection::UrlHelper::OptimizedUrlHelper
+      alias_method :call_without_maskara_check, :call
+
+      def call(t, args, inner_options)
+        maskara_prefix(t.controller) + call_without_maskara_check(t, args, inner_options)
+      end
+
+      def maskara_prefix(controller)
+        controller.maskara_request? ? "/#{Maskara.path_stub}" : ''
+      end
+    end
+  end
+end
+
+# Populate controllers with instance variables for maskara requests
+class AbstractController::Base
+  alias_method :process_action_without_maskara_check, :process_action
+
+  def process_action(method_name, *args)
+    if request.env['MASKARA_REQUEST']
+      maskara_populate_data(method_name)
+      render
+    else
+      process_action_without_maskara_check(method_name, *args)
+    end
+  end
+
+  def maskara_request?
+    request.env['MASKARA_REQUEST'] == true
+  end
+
+  def maskara_populate_data(action)
+    Maskara::Data.action_data(action, controller_path).each do |key, data|
+      instance_variable_set("@#{key}", maskara_presentable_data(data))
+    end
+  end
+
+  def maskara_presentable_data(data)
+    RecursiveOpenStruct.new(data, :recurse_over_arrays => true)
+  end
+end
+
+# Initialise maskara and disabled filters
+module Maskara
+  class Railtie < Rails::Railtie
+    initializer "maskara_railtie.configure_rails_initialization" do
+      Maskara.configure do |config|
+        config.data_path = Rails.root.join('db', 'fixtures')
+      end
+
+      Maskara::Data.skip_filters.each do |klass, filters|
+        filters.each { |filter| klass.skip_filter filter, if: :maskara_request? }
+      end
+    end
+
+    rake_tasks do
+      load 'maskara/tasks.rake'
+    end
+  end
+end

data/lib/maskara/tasks.rake

@@ -0,0 +1,10 @@
+require 'maskara/generator'
+
+namespace :maskara do
+
+  desc 'Generate a default maskara data file based on the existing controllers'
+  task :generate => :environment do
+    Maskara::Generator.run
+  end
+
+end

data/lib/maskara/version.rb

@@ -0,0 +1,3 @@
+module Maskara
+  VERSION = "1.0.0"
+end

data/maskara.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'maskara/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "maskara"
+  spec.version       = Maskara::VERSION
+  spec.authors       = ["Simon Hildebrandt"]
+  spec.email         = ["simon.hildebrandt@fairfaxmedia.com.au"]
+
+  spec.summary       = %q{Mask out your controller logic with mock data to make building views easier.}
+  spec.description   = %q{Mask out your controller logic with mock data to make building views easier.}
+  spec.homepage      = "https://bitbucket.org/fairfax/maskara"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'recursive-open-struct'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rails-dummy"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rails", "> 3"
+
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: maskara
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Simon Hildebrandt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: recursive-open-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: rails-dummy
+  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'
+- !ruby/object:Gem::Dependency
+  name: 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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Mask out your controller logic with mock data to make building views
+  easier.
+email:
+- simon.hildebrandt@fairfaxmedia.com.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/maskara.rb
+- lib/maskara/data.rb
+- lib/maskara/generator.rb
+- lib/maskara/middleware.rb
+- lib/maskara/railtie.rb
+- lib/maskara/tasks.rake
+- lib/maskara/version.rb
+- maskara.gemspec
+homepage: https://bitbucket.org/fairfax/maskara
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Mask out your controller logic with mock data to make building views easier.
+test_files: []