scoreable 0.0.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "1.2.0"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.0.7)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    method_source (0.8)
+    multi_json (1.3.6)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    slop (3.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (= 1.2.0)
+  jeweler (~> 1.8.4)
+  pry
+  rdoc (~> 3.12)
+  rspec (~> 2.8.0)
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Naveed Ahmad
+
+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,4 @@
+scoreable
+=========
+
+generate score for user on performing specific activities within your application. 

data/README.rdoc

@@ -0,0 +1,19 @@
+= scoreable
+
+Description goes here.
+
+== Contributing to scoreable
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 Naveed Ahmad. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "scoreable"
+  gem.homepage = "http://github.com/naveed-ahmad/scoreable"
+  gem.license = "MIT"
+  gem.summary = %Q{one-line summary of your gem}
+  gem.description = %Q{longer description of your gem}
+  gem.email = "naveedahmada036@gmail.com"
+  gem.authors = ["Naveed Ahmad"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "scoreable #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/generators/scoreable/config_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module Scoreable
+  class ConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "This generator creates an initializer file at config/initializers, " +
+         "with the default configuration options for Scoreable."
+    def add_initializer
+      template "initializer.rb", "config/initializers/scoreable.rb"
+    end
+
+    def show_readme
+       readme "README"
+    end
+  end
+end

data/lib/generators/scoreable/install_generator.rb

@@ -0,0 +1,30 @@
+module Scoreable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../templates", __FILE__)
+      desc "copy #{Scoreable.score_term}'s migration and model files to your application."
+
+      def self.next_migration_number(dirname)
+        Time.now.strftime("%Y%m%d%H%M%S")
+      end
+
+      def copy_model
+        template "score_model.rb", File.join("app", "models", "#{Scoreable.score_term}.rb")
+      end
+
+      def copy_migration
+        migration_template "migration.rb", File.join("db", "migrate", "create_#{table_name}.rb")
+      end
+
+      def show
+        readme "README2"
+      end
+
+      def table_name
+        Scoreable.table_name
+      end
+    end
+  end
+end

data/lib/generators/scoreable/templates/README

@@ -0,0 +1,7 @@
+==========================================================
+  Great now next steps are:
+    * Change configuration in config/initialize/scoreable.rb to configure your core term name what about 'point' or 'karma'?
+    * run rails g scoreable:install
+    * rake db:migrate
+    * read readme to learn how to generate scores for your users
+==========================================================

data/lib/generators/scoreable/templates/initializer.rb

@@ -0,0 +1,6 @@
+Scoreable.config do |config|
+
+  ## name of your scoring model(you might want to use 'point' instead)
+  #config.name = 'score'
+end
+

data/lib/generators/scoreable/templates/migration.rb

@@ -0,0 +1,27 @@
+class Create<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= Scoreable.table_name %>) do |t|
+      # earned <%= Scoreable.score_term %>
+      t.decimal :<%= Scoreable.score_term %>
+      
+      # <%= Scoreable.score_term%> receiver(polymorphic)
+      t.integer :<%= Scoreable.score_receiver_name.foreign_key %>
+      t.string :<%= Scoreable.score_receiver_name%>_type
+
+      # <%= Scoreable.score_term%> generator(polymorphic)
+      t.integer :<%= Scoreable.score_generator_name.foreign_key %>
+      t.string :<%= Scoreable.score_generator_name%>_type
+
+      #which action has generated this score
+      t.string :action
+      
+      t.timestamps
+    end
+
+    add_index :<%= Scoreable.table_name %>,  [<%= ":#{Scoreable.score_receiver_name.foreign_key}, :#{Scoreable.score_receiver_name}_type" %>], name: '<%= "index_#{Scoreable.table_name}_on_#{Scoreable.score_receiver_name}"%>'
+    add_index :<%= Scoreable.table_name %>,  [:<%= ":#{Scoreable.score_generator_name.foreign_key} , :#{Scoreable.score_generator_name}_type"%>], name: '<%= "index_#{Scoreable.table_name}_on_#{Scoreable.score_generator_name}"%>'
+
+    # remove comment if you want to use this index too
+    #add_index :<%= Scoreable.table_name %>,  [:<%= "#{Scoreable.score_generator_name}_type" %>, :action], name: '<%= "index_#{Scoreable.table_name}_on_#{Scoreable.score_generator_name}_type_and_action"%>'
+  end
+end

data/lib/generators/scoreable/templates/score_model.rb

@@ -0,0 +1,5 @@
+class <%= Scoreable.model_name%> < ActiveRecord::Base
+  belongs_to :<%= Scoreable.score_receiver_name%>, polymorphic: true
+  belongs_to :<%= Scoreable.score_generator_name%>, polymorphic: true
+
+end

data/lib/scoreable.rb

@@ -0,0 +1,31 @@
+module Scoreable
+  # name of "score"
+  mattr_accessor :score_term
+  @@score_term = 'score'
+  
+  def score_term=(term)
+    @@score_term = term.to_s.downcase
+  end
+
+  class << self
+    def config
+      yield self
+    end
+
+    def table_name
+      score_term.tableize
+    end
+
+    def model_name
+      score_term.camelize
+    end
+
+    def score_receiver_name
+      "#{score_term}_receiver"
+    end
+
+    def score_generator_name
+      "#{score_term}_generator"
+    end
+  end
+end

data/lib/scoreable/generator/active_record.rb

@@ -0,0 +1,63 @@
+module Scoreable
+  module Generator
+    module GeneratedMethods;  end
+
+    module ClassMethods
+      ## Scoreable.score_term = 'score'
+      ## use to configure score generation scheme
+      #  Example:
+      ##   give 5 points to user
+      ##   generate_score  create: {score: 5, for: :user}
+      ##   generate_score  create: 5 (need to set global score_reciever for this call using score_receiver= :receiver_object, :receiver_object could be a method that will return receiver
+      ##
+      ##   give 5 point to "user" on "create" and call "report_point" as callback
+      ##   generate_score create: { :score: 5, for: :user, callback: :report_score}
+      ##
+      ##    You can configure score for multiple method in single call
+      ##   generate_score update: 4, create: 5, upvote: {score: 5, for: :upvoter}
+      ##
+      def generate_score(args)
+        include Scoreable::Generator::InstanceMethods
+        
+        args.keys.each do |action|
+          score = args[action]
+          action = action.to_s
+
+          method_without_score_feature = action+"_without_#{Scoreable.score_term}"
+          method_with_score_feature = action+"_with_#{Scoreable.score_term}"
+
+          Scoreable::Generator::GeneratedMethods.class_eval do
+            define_method method_with_score_feature.to_sym do
+              send method_without_score_feature
+              log_score 5,action, 'user'
+            end
+          end
+        end
+
+        include Scoreable::Generator::GeneratedMethods
+
+        args.keys.each do |action|
+          alias_method_chain action, Scoreable.score_term
+        end
+      end
+
+      alias_method "generate_#{Scoreable.score_term}", :generate_score unless respond_to? "generate_#{Scoreable.score_term}"
+      
+      mattr_accessor :score_receiver
+      mattr_accessor "#{Scoreable.score_term}_receiver"
+    end
+
+    module InstanceMethods
+      
+      def itself
+        self
+      end
+
+      def  log_score(score,action,receiver)
+        receiver = self.send receiver if [String,Symbol].include? receiver.class
+        receiver.send(Scoreable.table_name).create! action: action, :"#{Scoreable.score_term}" => score, :"#{Scoreable.score_term}_generator" => self
+      end
+      alias_method "log_#{Scoreable.score_term}_receiver", :log_score
+    end
+  end
+end

data/lib/scoreable/receiver/active_record.rb

@@ -0,0 +1,19 @@
+module Scoreable
+  module Receiver
+    module ClassMethods
+      define_method "receive_#{Scoreable.score_term}" do
+        has_many  "#{Scoreable.table_name}".to_sym, as: Scoreable.score_receiver_name
+        
+        include Scoreable::Receiver::InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+      define_method "total_#{Scoreable.score_term}" do
+        eval(Scoreable.table_name).sum Scoreable.score_term
+      end
+    end
+  end
+end
+
+

data/lib/scoreable/scoreable.rb

@@ -0,0 +1,11 @@
+require 'rails'
+require 'scoreable/generator/active_record'
+require 'scoreable/receiver/active_record'
+require 'scoreable/scoreable'
+
+module Scoreable
+  ActiveRecord::Base.class_eval do
+    extend Scoreable::Generator::ClassMethods
+    extend Scoreable::Receiver::ClassMethods
+  end
+end

data/scoreable.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{scoreable}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Naveed Ahmad}]
+  s.date = %q{2012-09-11}
+  s.description = %q{longer description of your gem}
+  s.email = %q{naveedahmada036@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/generators/scoreable/config_generator.rb",
+    "lib/generators/scoreable/install_generator.rb",
+    "lib/generators/scoreable/templates/README",
+    "lib/generators/scoreable/templates/README2",
+    "lib/generators/scoreable/templates/initializer.rb",
+    "lib/generators/scoreable/templates/migration.rb",
+    "lib/generators/scoreable/templates/score_model.rb",
+    "lib/scoreable.rb",
+    "lib/scoreable/generator/active_record.rb",
+    "lib/scoreable/receiver/active_record.rb",
+    "lib/scoreable/scoreable.rb",
+    "scoreable.gemspec",
+    "spec/scoreable_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/naveed-ahmad/scoreable}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{one-line summary of your gem}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["= 1.2.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["= 1.2.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["= 1.2.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

data/spec/scoreable_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe Scoreable do
+
+  context "Configuration" do
+
+  end
+
+  context "Generators" do
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'scoreable'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: scoreable
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Naveed Ahmad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &76344800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *76344800
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &76344510 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *76344510
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &76344160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *76344160
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &76343850 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: *76343850
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &76343430 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *76343430
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &76343040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *76343040
+description: longer description of your gem
+email: naveedahmada036@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/generators/scoreable/config_generator.rb
+- lib/generators/scoreable/install_generator.rb
+- lib/generators/scoreable/templates/README
+- lib/generators/scoreable/templates/README2
+- lib/generators/scoreable/templates/initializer.rb
+- lib/generators/scoreable/templates/migration.rb
+- lib/generators/scoreable/templates/score_model.rb
+- lib/scoreable.rb
+- lib/scoreable/generator/active_record.rb
+- lib/scoreable/receiver/active_record.rb
+- lib/scoreable/scoreable.rb
+- scoreable.gemspec
+- spec/scoreable_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/naveed-ahmad/scoreable
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 915395293
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: one-line summary of your gem
+test_files: []