gamification 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff0f5c1e1337b6cf63206c829cc642f095b94621
+  data.tar.gz: c264313d9ed05c33287888e0e9e81ebc99ba4f58
+SHA512:
+  metadata.gz: fb23fabcb4db26e71e7001fb6f2c0e65c8fe2ebd2df47f0acf7b02c624a7b2ea9b3df665672094d1dc8e6b43e733fbd61221e13b07265dff1730d75a2313b6e3
+  data.tar.gz: a344fdd6a6534e4065eaf6794d8e520bbf8ff9db4fd6e757f27a2834eb254928ac5b4b91b16f6516cd4798d6370f10870843575e2c668c0bebf60b62c07c160f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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,28 @@
+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    = 'Mingle'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new spec: 'app:db:test:prepare'
+
+task default: :spec

data/app/assets/javascripts/gamification/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/app/assets/stylesheets/gamification/application.css

@@ -0,0 +1,15 @@
+/*
+ * 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/gamification/application_controller.rb

@@ -0,0 +1,4 @@
+module Gamification
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/gamification/application_helper.rb

@@ -0,0 +1,4 @@
+module Gamification
+  module ApplicationHelper
+  end
+end

data/app/models/gamification/scoring.rb

@@ -0,0 +1,5 @@
+module Gamification
+  class Scoring < ActiveRecord::Base
+    include Concerns::Models::Scoring
+  end
+end

data/app/models/gamification/task.rb

@@ -0,0 +1,5 @@
+module Gamification
+  class Task < ActiveRecord::Base
+    include Concerns::Models::Task
+  end
+end

data/app/views/layouts/gamification/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Gamification</title>
+  <%= stylesheet_link_tag    "gamification/application", media: "all" %>
+  <%= javascript_include_tag "gamification/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Gamification::Engine.routes.draw do
+end

data/db/migrate/20140309173049_create_gamification_tasks.rb

@@ -0,0 +1,10 @@
+class CreateGamificationTasks < ActiveRecord::Migration
+  def change
+    create_table :gamification_tasks do |t|
+      t.references :taskable, polymorphic: true, index: true
+      t.integer :points
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140309175957_create_gamification_scorings.rb

@@ -0,0 +1,12 @@
+class CreateGamificationScorings < ActiveRecord::Migration
+  def change
+    create_table :gamification_scorings do |t|
+      t.references :task, index: true
+      t.references :subjectable, polymorphic: true
+
+      t.timestamps
+    end
+
+    add_index :gamification_scorings, [:subjectable_id, :subjectable_type], name: 'index_gamification_scorings_on_subjectable'
+  end
+end

data/lib/gamification.rb

@@ -0,0 +1,5 @@
+require "gamification/engine"
+require "gamification/concerns"
+
+module Gamification
+end

data/lib/gamification/concerns.rb

@@ -0,0 +1,3 @@
+module Gamification::Concerns
+  require "gamification/concerns/models"
+end

data/lib/gamification/concerns/models.rb

@@ -0,0 +1,4 @@
+module Gamification::Concerns::Models
+  require "gamification/concerns/models/task"
+  require "gamification/concerns/models/scoring"
+end

data/lib/gamification/concerns/models/scoring.rb

@@ -0,0 +1,8 @@
+module Gamification::Concerns::Models::Scoring
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :task
+    belongs_to :subjectable, polymorphic: true
+  end
+end

data/lib/gamification/concerns/models/task.rb

@@ -0,0 +1,50 @@
+module Gamification::Concerns::Models::Task
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :taskable, polymorphic: true
+    has_many :scorings
+
+    # TODO: These should be SQL. But that's hard.
+    scope :completed_by,  ->(subject) { all.select { |task| task.completed_by? subject }}
+    scope :incomplete_by, ->(subject) { all.reject { |task| task.completed_by? subject }}
+
+    # Determine whether the given subject has completed the task.
+    #
+    # subject - An ActiveRecord model that can receive scorings.
+    def completed_by? subject
+      !!scoring_for(subject)
+    end
+
+    # Complete the task for the given subject.
+    #
+    # subject - An ActiveRecord model that can receive scorings.
+    def complete_for subject
+      if completed_by? subject
+        raise Completed, "Task is already completed for #{subject}"
+      else
+        ::Gamification::Scoring.create! task: self, subjectable: subject
+      end
+    end
+
+    private
+
+    # Find the Scoring for the given subject.
+    #
+    # subject - An ActiveRecord model that can receive scorings.
+    def scoring_for subject
+      scorings.find_by subjectable: subject
+    end
+
+    class Completed < StandardError; end
+  end
+
+  module ClassMethods
+    # Complete all tasks for the given subject.
+    #
+    # subject - An ActiveRecord model that can receive scorings.
+    def complete_for subject
+      all.map { |task| task.complete_for subject unless task.completed_by? subject }.compact
+    end
+  end
+end

data/lib/gamification/engine.rb

@@ -0,0 +1,12 @@
+module Gamification
+  class Engine < ::Rails::Engine
+    isolate_namespace Gamification
+
+    config.generators do |g|
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+      g.assets false
+      g.helper false
+    end
+  end
+end

data/lib/gamification/version.rb

@@ -0,0 +1,3 @@
+module Gamification
+  VERSION = "0.0.2"
+end

data/lib/tasks/gamification_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :gamification do
+#   # Task goes here
+# 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__)
+
+Rails.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,15 @@
+/*
+ * 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 bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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/models/article.rb

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+  has_many :tasks, as: :taskable
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_many :scorings, as: :subjectable
+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.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,29 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "gamification"
+
+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.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,30 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# 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:
+  <<: *default
+  database: db/test.sqlite3
+
+# Do not keep production credentials in the repository,
+# instead read the configuration from the environment.
+#
+# Example:
+#   sqlite3://myuser:mypass@localhost/full/path/to/somedatabase
+#
+production:
+  url: <%= ENV["DATABASE_URL"] %>