work_in_progress 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a394d2958769130db0b532c19da62011bc28c9a
+  data.tar.gz: 09af8601837c7130b54e8daf9def5d3d872cf5ed
+SHA512:
+  metadata.gz: 7cd841e6af08fa976098427aafd71238033265d3514caacbc858766c1aa611950cb38f74b3d423b30b5fe4954c23465c67de563de986d60fea9cac37e4b1dec2
+  data.tar.gz: 011f2504e0f2efea3a551dadbc323ca0df4c1e9176f0dec51143c00ae654927f0e80d40e926f5617d33f1b47f8bd57ca2a0235d8c9637081db20b03d8f7db6a6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in work_in_progress.gemspec
+gemspec
+
+gem "rails", "4.2.1"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Michał Krajewski
+
+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,31 @@
+# WorkInProgress
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'work_in_progress'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install work_in_progress
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/work_in_progress/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/**/*_test.rb"
+end

data/lib/generators/templates/work_in_progress.rb

@@ -0,0 +1,4 @@
+WorkInProgress.setup do |config|
+  config.framework = :rails
+  config.permited_users = []
+end

data/lib/generators/work_in_progress/install_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators/base'
+
+module WorkInProgress
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Devise initializer and copy locale files to your application."
+      def copy_initializer
+        template "work_in_progress.rb", "config/initializers/work_in_progress.rb"
+      end
+    end
+  end
+end

data/lib/work_in_progress.rb

@@ -0,0 +1,23 @@
+require "work_in_progress/version"
+require "work_in_progress/view_helpers"
+
+if defined?(Rails)
+  require "work_in_progress/railtie"
+end
+
+module WorkInProgress
+
+  # Choose framework solution
+  mattr_accessor :framework
+  @@framework = nil
+
+  # List permited users emails
+  mattr_accessor :permited_users
+  @@permited_users = []
+
+  # Default way to setup Work in Progress.
+  def self.setup
+    yield self
+  end
+
+end

data/lib/work_in_progress/railtie.rb

@@ -0,0 +1,7 @@
+module WorkInProgress
+  class Railtie < Rails::Railtie
+    initializer 'work_in_progress.view_helpers' do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/work_in_progress/version.rb

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

data/lib/work_in_progress/view_helpers.rb

@@ -0,0 +1,32 @@
+require 'action_view'
+
+include ActionView::Helpers::TagHelper
+include ActionView::Context
+
+module WorkInProgress
+  module ViewHelpers
+    def work_in_progress(opts={}, &block)
+      if user_is_permited?(opts)
+        case WorkInProgress.framework
+        when :rails
+          rails_content(&block)
+        end
+      end
+    end
+
+    private
+
+      def rails_content(&block)
+        content_tag(:div, capture(&block), style: "background-color: #ccc;")
+      end
+
+      def user_is_permited?(opts={})
+        if defined?(current_user)
+          WorkInProgress.permited_users.include?(current_user.email)
+        elsif opts[:user]
+          WorkInProgress.permited_users.include?(opts[:user].email)
+        end
+      end
+
+  end
+end

data/test/generators/install_generator_test.rb

@@ -0,0 +1,12 @@
+require "test_helper"
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  tests WorkInProgress::Generators::InstallGenerator
+  destination File.expand_path("../../tmp", __FILE__)
+  setup :prepare_destination
+
+  test "Assert all files are properly created" do
+    run_generator
+    assert_file "config/initializers/work_in_progress.rb"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+require 'rails'
+
+if ActiveSupport.respond_to?(:test_order)
+  ActiveSupport.test_order = :random
+end
+
+require "rails/generators/test_case"
+require "generators/work_in_progress/install_generator"

data/test/view_helpers_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+require 'work_in_progress'
+
+class ViewHelpersTest < Minitest::Test
+  def setup
+    @object = Object.new
+    @object.extend(WorkInProgress::ViewHelpers)
+  end
+
+  def content
+    "<div style=\"background-color: #ccc;\">hello!</div>"
+  end
+
+  User = Struct.new(:email)
+
+  # Test Rails
+  def test_rails_for_all
+    WorkInProgress.setup do |config|
+      config.framework = :rails
+    end
+
+    assert_nil(@object.work_in_progress { "hello!" })
+  end
+
+  def test_rails_for_unpermitted_users
+    WorkInProgress.setup do |config|
+      config.framework = :rails
+      config.permited_users = ["permited@example.com"]
+    end
+
+    user = User.new("notpermited@example.com")
+    assert_nil(@object.work_in_progress(user: user) { "hello!" })
+  end
+
+  def test_rails_for_permitted_users
+    WorkInProgress.setup do |config|
+      config.framework = :rails
+      config.permited_users = ["permited@example.com"]
+    end
+
+    user = User.new("permited@example.com")
+    assert_equal(content, @object.work_in_progress(user: user) { "hello!" })
+  end
+
+  # Test other frameworks
+  def test_sinatra
+    WorkInProgress.setup do |config|
+      config.framework = :sinatra
+    end
+
+    assert_nil(@object.work_in_progress { "hello!" })
+  end
+end

data/work_in_progress.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'work_in_progress/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "work_in_progress"
+  spec.version       = WorkInProgress::VERSION
+  spec.authors       = ["Michał Krajewski"]
+  spec.email         = ["contact@mkrajewski.net"]
+  spec.summary       = %q{Work in Progress.}
+  spec.description   = %q{Gem that helps you hide and show work in progress.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: work_in_progress
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michał Krajewski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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'
+description: Gem that helps you hide and show work in progress.
+email:
+- contact@mkrajewski.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/templates/work_in_progress.rb
+- lib/generators/work_in_progress/install_generator.rb
+- lib/work_in_progress.rb
+- lib/work_in_progress/railtie.rb
+- lib/work_in_progress/version.rb
+- lib/work_in_progress/view_helpers.rb
+- test/generators/install_generator_test.rb
+- test/test_helper.rb
+- test/view_helpers_test.rb
+- work_in_progress.gemspec
+homepage: ''
+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.2
+signing_key: 
+specification_version: 4
+summary: Work in Progress.
+test_files:
+- test/generators/install_generator_test.rb
+- test/test_helper.rb
+- test/view_helpers_test.rb