lazy_crud 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02b7f6af2ad8a5c3867f8c9702a7992f5ec4101f
+  data.tar.gz: ec1598c7d0b7b5e9f854e8971f044fdba82ccb21
+SHA512:
+  metadata.gz: 242d7160db8d6066cbc5e6676cf46c192167eb57be0b32ad191691b7a6cf10f5ff0a4888e66d50c1eff104ea2e8faf4826355f916acd609b1c9f6a87296c0799
+  data.tar.gz: 06e045db9a2878494cd7195a279a09e812c53fb56b22dffe7a414dc16eda05600534185a3d53589b5dc482d750bd6796a95c60a6dd2eb7160794705245517e55

data/.codeclimate.yml

@@ -0,0 +1,7 @@
+languages:
+  Ruby: true
+  JavaScript: false
+  PHP: false
+  Python: false
+exclude_paths:
+  - spec/

data/.gitignore

@@ -0,0 +1,37 @@
+*.rbc
+*.gem
+capybara-*.html
+.rspec
+/log
+*.log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalisation:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalise the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+bundler_args: --without guard
+rvm:
+  - "2.0"
+  - "2.1"
+  - "2.2"
+  - ruby-head
+script: "bundle exec rspec"
+addons:
+  code_climate:
+    repo_token: 4ce664811485b705e1c44aa00ff41f207347874b2e840e38f27880f8ebaf96e5
+branches:
+  only: master
+notifications:
+  email: false

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,142 @@
+PATH
+  remote: .
+  specs:
+    lazy_crud (0.9.0)
+      activesupport (>= 3.0.0)
+      i18n
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.1.10)
+      actionpack (= 4.1.10)
+      actionview (= 4.1.10)
+      mail (~> 2.5, >= 2.5.4)
+    actionpack (4.1.10)
+      actionview (= 4.1.10)
+      activesupport (= 4.1.10)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    actionview (4.1.10)
+      activesupport (= 4.1.10)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    activemodel (4.1.10)
+      activesupport (= 4.1.10)
+      builder (~> 3.1)
+    activerecord (4.1.10)
+      activemodel (= 4.1.10)
+      activesupport (= 4.1.10)
+      arel (~> 5.0.0)
+    activesupport (4.1.10)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    awesome_print (1.6.1)
+    builder (3.2.2)
+    byebug (4.0.5)
+      columnize (= 0.9.0)
+    codeclimate-test-reporter (0.4.7)
+      simplecov (>= 0.7.1, < 1.0.0)
+    coderay (1.1.0)
+    columnize (0.9.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    erubis (2.7.0)
+    factory_girl (4.5.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.5.0)
+      factory_girl (~> 4.5.0)
+      railties (>= 3.0.0)
+    i18n (0.7.0)
+    json (1.8.2)
+    mail (2.6.3)
+      mime-types (>= 1.16, < 3)
+    method_source (0.8.2)
+    mime-types (2.5)
+    minitest (5.6.1)
+    paranoia (2.1.1)
+      activerecord (~> 4.0)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.1.0)
+      byebug (~> 4.0)
+      pry (~> 0.10)
+    rack (1.5.2)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.1.10)
+      actionmailer (= 4.1.10)
+      actionpack (= 4.1.10)
+      actionview (= 4.1.10)
+      activemodel (= 4.1.10)
+      activerecord (= 4.1.10)
+      activesupport (= 4.1.10)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.1.10)
+      sprockets-rails (~> 2.0)
+    railties (4.1.10)
+      actionpack (= 4.1.10)
+      activesupport (= 4.1.10)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-rails (3.2.1)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    sprockets (3.0.2)
+      rack (~> 1.0)
+    sprockets-rails (2.2.4)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (>= 2.8, < 4.0)
+    sqlite3 (1.3.10)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  bundler
+  codeclimate-test-reporter
+  factory_girl_rails (~> 4.4)
+  lazy_crud!
+  paranoia
+  pry-byebug
+  rails (>= 4)
+  rspec
+  rspec-rails
+  sqlite3

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 L. Preston Sego III
+
+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,69 @@
+# lazy_crud
+Lazy way to implement common actions in controllers in Rails
+
+[![docs](https://img.shields.io/badge/docs-yardoc-blue.svg?style=flat-square)](http://www.rubydoc.info/github/NullVoxPopuli/lazy_crud)
+[![Gem Version](http://img.shields.io/gem/v/lazy_crud.svg?style=flat-square)](http://badge.fury.io/rb/lazy_crud)
+[![Build Status](http://img.shields.io/travis/NullVoxPopuli/lazy_crud.svg?style=flat-square)](https://travis-ci.org/NullVoxPopuli/lazy_crud)
+[![Code Climate](http://img.shields.io/codeclimate/github/NullVoxPopuli/lazy_crud.svg?style=flat-square)](https://codeclimate.com/github/NullVoxPopuli/lazy_crud)
+[![Test Coverage](http://img.shields.io/codeclimate/coverage/github/NullVoxPopuli/lazy_crud.svg?style=flat-square)](https://codeclimate.com/github/NullVoxPopuli/lazy_crud)
+[![Dependency Status](http://img.shields.io/gemnasium/NullVoxPopuli/lazy_crud.svg?style=flat-square)](https://gemnasium.com/NullVoxPopuli/lazy_crud)
+
+
+## Features
+
+ - Minimal Controller Coding
+ - Resource Can be Scoped to Parent Resource
+
+### TODO
+
+ - Generic Error Handeling
+ - i18n
+ - lambdas and procs for inserting custom behavior
+
+## Installation
+
+Gemfile
+
+    gem 'lazy_crud'
+
+Terminal
+
+    gem install lazy_crud
+
+## Configuration
+
+
+### Basic setup
+
+    class SomeObjectController < ApplicationController
+      include LazyCrud
+
+      # At a bare minimum, you'll need to specify the
+      # class the controller is acting upon.
+      set_resource SomeObject
+
+      # optional
+      # this is for in the case of you having nested routes, and want to scope
+      # SomeObject to its parent object.
+      # For example: /event/:event_id/discounts/:id
+      # Event is the parent object and Discount is the resource
+      #
+      # Note that there must be an @event instance variable set
+      #
+      # See specs for details
+      set_resource_parent Event
+
+      # sort of optional
+      # if you want to be able to update / create objects, you'll want to
+      # specify what parameters are allowed to be set.
+      # this uses strong parameters
+      set_param_whitelist(:name, :amount)
+    end
+
+## Contributing
+
+1. Fork the project
+2. Create a new, descriptively named branch
+3. Add Test(s)!
+4. Commit your proposed changes
+5. Submit a pull request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/config/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  lazy_crud:
+    crud:
+      success:
+        create: ''
+        update: ''
+        destroy: ''
+      failure:
+        create: ''
+        update: ''
+        destroy: ''

data/lazy_crud.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lazy_crud/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lazy_crud"
+  s.version     = LazyCrud::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.license     = "MIT"
+  s.authors     = ["L. Preston Sego III"]
+  s.email       = "LPSego3+dev@gmail.com"
+  s.homepage    = "https://github.com/NullVoxPopuli/lazy_crud"
+  s.summary     = "LazyCrud-#{LazyCrud::VERSION}"
+  s.description = "Lazy way to implement common actions in controllers in Rails."
+
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.add_runtime_dependency "activesupport", ">= 3.0.0"
+  s.add_runtime_dependency "i18n"
+
+  # 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 "rails", ">= 4"
+  s.add_development_dependency "factory_girl_rails", "~> 4.4"
+  s.add_development_dependency "paranoia"
+  s.add_development_dependency "awesome_print"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "pry-byebug"
+  s.add_development_dependency "codeclimate-test-reporter"
+
+end

data/lib/lazy_crud/version.rb

@@ -0,0 +1,3 @@
+module LazyCrud
+  VERSION = "0.9.0"
+end

data/lib/lazy_crud.rb

@@ -0,0 +1,161 @@
+require 'active_support'
+
+require 'lazy_crud/version'
+
+module LazyCrud
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :resource_class
+    class_attribute :parent_class
+    class_attribute :param_whitelist
+
+    before_action :set_resource, only: [:show, :edit, :update, :destroy]
+    before_action :set_resource_instance, only: [:show, :edit, :update, :destroy]
+  end
+
+  module ClassMethods
+
+    # all REST actions will take place on an instance of this class
+    def set_resource(klass)
+      self.resource_class = klass
+    end
+
+    # for scoping the resource
+    # useful for nested routes, such as
+    # /event/:event_id/package/:package_id
+    # where Event would be the parent class and would scope
+    # the package
+    def set_resource_parent(klass)
+      self.parent_class = klass
+    end
+
+    # the list of parameters to allow through the strong parameter filter
+    def set_param_whitelist(*param_list)
+      self.param_whitelist = param_list
+    end
+
+  end
+
+  def index
+    set_collection_instance
+  end
+
+  def show
+    # instance variable set in before_action
+  end
+
+  def new
+    set_resource_instance(resource_proxy.new)
+  end
+
+  def edit
+    # instance variable set in before_action
+  end
+
+  def create
+    @resource = resource_proxy.build(resource_params)
+
+    # ensure we can still use model name-based instance variables
+    set_resource_instance
+
+    if @resource.save
+      flash[:notice] = "#{resource_name} has been created."
+      redirect_to action: :index
+    else
+      render action: :new
+    end
+  end
+
+  def update
+    if @resource.update(resource_params)
+      redirect_to action: :index
+    else
+      redirect_to action: :edit
+    end
+  end
+
+  def destroy
+    @resource.destroy
+
+    flash[:notice] = "#{resource_name} has been deleted."
+    redirect_to action: :index
+  end
+
+  # only works if deleting of resources occurs by setting
+  # the deleted_at field
+  def undestroy
+    @resource = resource_proxy(true).find(params[:id])
+    set_resource_instance
+
+    @resource.deleted_at = nil
+    @resource.save
+
+    flash[:notice] = "#{resource_name} has been undeleted"
+    redirect_to action: :index
+  end
+
+  private
+
+  def resource_name
+    @resource.try(:name) || @resource.class.name
+  end
+
+  def set_resource
+    @resource = resource_proxy.find(params[:id])
+  end
+
+  def resource_params
+    params[resource_singular_name].permit(self.class.param_whitelist)
+  end
+
+  # determines if we want to use the parent class if available or
+  # if we just use the resource class
+  def resource_proxy(with_deleted = false)
+    proxy = if parent_instance.present?
+      parent_instance.send(resource_plural_name)
+    else
+      self.class.resource_class
+    end
+
+    if with_deleted and proxy.respond_to?(:with_deleted)
+      proxy = proxy.with_deleted
+    end
+
+    proxy
+  end
+
+  # allows all of our views to still use things like
+  # @level, @event, @whatever
+  # rather than just @resource
+  def set_resource_instance(resource = @resource)
+    instance_variable_set("@#{resource_singular_name}", resource)
+  end
+
+  # sets the plural instance variable for a collection of objects
+  def set_collection_instance
+    instance_variable_set("@#{resource_plural_name}", resource_proxy)
+  end
+
+  def parent_instance
+    unless @parent
+      # e.g.: Event => 'event'
+      parent_instance_name = self.class.parent_class.name.underscore
+      @parent = instance_variable_get("@#{parent_instance_name}")
+    end
+
+    @parent
+  end
+
+  # e.g.: Event => 'events'
+  def resource_plural_name
+    @association_name ||= self.class.resource_class.name.tableize
+  end
+
+  # e.g.: Event => 'event'
+  # alternatively, @resource.class.name.underscore
+  def resource_singular_name
+    @singular_name ||= resource_plural_name.singularize
+  end
+
+end

data/spec/integration/discounts_controller_spec.rb

@@ -0,0 +1,95 @@
+require 'rails_helper'
+
+describe DiscountsController, type: :controller do
+
+  before(:each) do
+    @user = create(:user)
+    @event = create(:event, user: @user)
+  end
+
+  describe '#index' do
+    it 'sets the collection' do
+      create(:discount, event: @event)
+      get :index, event_id: @event.id
+
+      expect(assigns(:discounts)).to be_present
+    end
+  end
+
+  describe '#show' do
+
+    it 'gets the resource' do
+      discount = create(:discount, event: @event)
+      get :show, event_id: @event.id, id: discount.id
+
+      expect(assigns(:discount)).to eq discount
+    end
+  end
+
+  describe '#new' do
+    it 'creates an instance of the object' do
+      get :new, event_id: @event.id
+
+      expect(assigns(:discount)).to be_new_record
+    end
+  end
+
+  describe '#edit' do
+
+
+    it 'sets the instance of the object' do
+      discount = create(:discount, event: @event)
+      get :edit, event_id: @event.id, id: discount.id
+      expect(assigns(:discount)).to eq discount
+    end
+  end
+
+  describe '#create' do
+    it 'creates and persists a new object' do
+      expect{
+        post :create, event_id: @event.id, discount: build(:discount).attributes
+      }.to change(Discount, :count).by 1
+
+      expect(assigns(:discount)).to be_present
+    end
+  end
+
+  describe '#update' do
+    it 'updates and persists changes' do
+      discount = create(:discount, event: @event)
+      put :update, event_id: @event.id, id: discount.id,
+        discount: { name: "updated" }
+
+      field = assigns(:discount)
+      expect(field.name).to eq "updated"
+    end
+  end
+
+
+  describe '#destroy' do
+    it 'destroys the object' do
+      discount = create(:discount, event: @event)
+
+      expect{
+        delete :destroy, event_id: @event.id, id: discount.id
+      }.to change(@event.discounts, :count).by -1
+
+      expect(assigns(:discount).deleted_at).to be_present
+    end
+  end
+
+
+  describe '#undestroy' do
+    it 'un destroys the object' do
+      discount = create(:discount, event: @event, deleted_at: Time.now)
+
+      expect{
+        post :undestroy, event_id: @event.id, id: discount.id
+      }.to change(@event.discounts, :count).by 1
+
+      expect(assigns(:discount)).to be_present
+    end
+  end
+
+
+end

data/spec/rails_helper.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+require 'factory_girl_rails'
+require 'rails/all'
+require 'rspec/rails'
+
+ActiveRecord::Migration.maintain_test_schema!
+
+require 'support/rails_app/config/environment'
+
+# set up db
+# be sure to update the schema if required by doing
+# - cd spec/rails_app
+# - rake db:migrate
+ActiveRecord::Schema.verbose = false
+load "support/rails_app/db/schema.rb" # use db agnostic schema by default

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+require "rubygems"
+require "bundler/setup"
+
+require "pry-byebug" # binding.pry to debug!
+
+# Coverage
+require "codeclimate-test-reporter"
+ENV['CODECLIMATE_REPO_TOKEN'] = "4ce664811485b705e1c44aa00ff41f207347874b2e840e38f27880f8ebaf96e5"
+CodeClimate::TestReporter.start
+
+require 'rspec/autorun'
+require 'factory_girl'
+
+# This Gem
+require "lazy_crud"
+
+Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each {|file|
+  # skip the dummy app
+  next if file.include?('support/rails_app')
+  require file
+}
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end