gioco 0.3.6 → 1.0.0

data/lib/generators/gioco/generator_instructions.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+module GeneratorInstructions
+	def instructions
+		puts <<-EOS
+
+=======================================================
+
+Gioco successfully installed.
+
+Now you are able to add Badges using:
+  rake gioco:add_badge[BADGE_NAME#{",POINTS" if options[:points]}#{",TYPE_NAME" if options[:types]},DEFAULT]
+
+To remove Badges using:
+  rake gioco:remove_badge[BADGE_NAME#{",TYPE_NAME" if options[:types]}]
+
+#{
+  if options[:types]
+"And to remove Types using:
+  rake gioco:remove_type[TYPE_NAME]"
+  end
+}
+
+For usage and more infomation go to the documentation:
+http://joaomdmoura.github.com/gioco/
+
+By João Moura (a.k.a joaomdmoura)
+
+=======================================================
+
+		EOS
+	end
+end

data/lib/generators/gioco/migrations_generator.rb

@@ -0,0 +1,18 @@
+module MigrationsGenerator
+ def migrating
+    puts <<-EOS
+
+=======================================
+> Running rake db:migrate
+=======================================
+
+    EOS
+    rake("db:migrate")
+  end
+
+  def configuring_seed
+    empty_directory "db/gioco"
+    create_file "db/gioco/db.rb"
+    append_file 'db/seeds.rb', 'require "#{Rails.root}/db/gioco/db.rb"'
+  end
+end

data/lib/generators/gioco/model_generator.rb

@@ -0,0 +1,63 @@
+module ModelGenerator
+  def generate_models
+    generate("model", "level badge_id:integer #{@model_name}_id:integer")
+    if options[:types]
+      generate("model", "point user_id:integer type_id:integer value:integer")
+      generate("model", "type name:string") 
+      generate("model", "badge name:string type_id:integer  #{(options[:points]) ? "points:integer" : ""} default:boolean")
+    else
+      generate("migration", "add_points_to_#{@model_name.pluralize} points:integer") if options[:points]
+      generate("model", "badge name:string #{(options[:points]) ? "points:integer" : ""} default:boolean")
+    end
+  end
+
+  def creating_templates
+    @points = (options[:points] ) ? true : false
+    @types = (options[:types] ) ? true : false
+    template "gioco.rb", "config/initializers/gioco.rb"
+  end
+
+  def adding_methods
+    resource = File.read find_in_source_paths("resource.rb")
+    badge    = File.read find_in_source_paths("badge.rb")
+    inject_into_class "app/models/#{@model_name}.rb", @model_name.capitalize, "\n#{resource}\n"
+    inject_into_class "app/models/badge.rb", "Badge", "\n#{badge}\n"
+  end
+
+  def setup_relations
+    add_relationship("badge", "levels", "has_many", false, "destroy")
+    add_relationship("badge", @model_name.pluralize, "has_many", "levels")
+    
+    add_relationship(@model_name, "levels", "has_many")
+    add_relationship(@model_name, "badges", "has_many", "levels")
+
+    add_relationship("level", @model_name, "belongs_to")
+    add_relationship("level", "badge", "belongs_to")
+
+    if options[:types]
+      add_relationship(@model_name, "points", "has_many")
+      add_relationship("type", "points", "has_many")
+      add_relationship("type", "badges", "has_many")
+      add_relationship("badge", "type", "belongs_to")
+      add_relationship("point", @model_name, "belongs_to")
+      add_relationship("point", "type", "belongs_to")
+    end
+  end
+
+  def add_validations
+    add_validation("badge", "name", [["presence", "true"]])
+    add_validation("type", "name", [["uniqueness", "true"], ["presence", "true"]]) if options[:types]
+  end
+
+  private
+
+  def add_relationship (model, related, relation, through = false, dependent = false)
+    inject_into_class "app/models/#{model}.rb", model.capitalize, "#{relation} :#{related} #{(through) ? ", :through => :#{through}" : ""} #{(dependent) ? ", :dependent => :#{dependent}" : ""}\n"
+  end
+
+  def add_validation (model, field, validations = [])
+    validations.each do |validation|
+      inject_into_class "app/models/#{model}.rb", model.capitalize, "validates :#{field}, :#{validation[0]} => #{validation[1]}\n"
+    end
+  end
+end

data/lib/generators/gioco/rakes_generator.rb

@@ -0,0 +1,101 @@
+module RakesGenerator
+  def create_rakes
+  rakefile("gioco.rake") do
+        <<-EOS
+# -*- encoding: utf-8 -*-
+namespace :gioco do
+  
+  desc "Used to add a new badge at Gioco scheme"
+  
+  task :add_badge, [:name, #{":points, " if options[:points]}#{":type, " if options[:types]}:default] => :environment do |t, args|
+    arg_default = ( args.default ) ? eval(args.default) : false
+
+
+    if !args.name #{"|| !args.points" if options[:points]}#{" || !args.type" if options[:types]}
+      raise "There are missing some arguments"
+    else
+      badge_string = "#{options[:types] ? 'type = Type.find_or_create_by_name(\'#{args.type}\')\n' : ''}"
+
+      badge_string = badge_string + "badge = Badge.create({ 
+                      :name => \'\#\{args.name\}\', 
+                      #{":points => \'\#\{args.points\}\'," if options[:points]}
+                      #{":type_id  => type.id," if options[:types]}
+                      :default => \'\#\{arg_default\}\'
+                    })\n"
+
+      if arg_default
+        badge_string = badge_string + 'resources = #{@model_name.capitalize}.find(:all)\n'
+        badge_string = badge_string + "resources.each do |r|
+        #{
+        if options[:points] && options[:types]
+            "r.points  << Point.create({ :type_id => type.id, :value => \'\#\{args.points\}\'})"
+        elsif options[:points]
+          "r.points = \'\#\{args.points\}\'"
+        end
+        }
+          r.badges << badge
+          r.save!
+        end\n"
+      end
+      
+      badge_string = badge_string + "puts '> Badge successfully created'"
+
+      eval badge_string
+      
+      file_path = "/db/gioco/create_badge_\#\{args.name\}#{"_\#\{args.type\}" if options[:types]}.rb"
+      File.open("\#\{Rails.root\}\#\{file_path\}", 'w') { |f| f.write badge_string }
+      File.open("\#\{Rails.root\}/db/gioco/db.rb", 'a') { |f| f.write "require \\"\\#\\{Rails.root\\}\#\{file_path\}\\"\n" }
+
+    end
+
+  end
+
+  desc "Used to remove an old badge at Gioco scheme"
+
+  task :remove_badge, [:name#{", :type" if options[:types]}] => :environment do |t, args|
+    if !args.name#{" || !args.type" if options[:types]}
+      raise "There are missing some arguments"
+    else
+      badge_string = "#{"type = Type.find_by_name('\#\{args.type\}')" if options[:types]}
+      badge = Badge.where( :name => '\#\{args.name\}'#{", :type_id => type.id" if options[:types]} ).first
+      badge.destroy\n"
+    end
+
+    badge_string = badge_string + "puts '> Badge successfully removed'"
+
+    eval badge_string
+    
+    file_path = "/db/gioco/remove_badge_\#\{args.name\}.rb"
+    File.open("\#\{Rails.root\}\#\{file_path\}", 'w') { |f| f.write badge_string }
+    File.open("\#\{Rails.root\}/db/gioco/db.rb", 'a') { |f| f.write "require \\"\\#\\{Rails.root\\}\#\{file_path\}\\"\n" }
+  end
+#{
+if options[:types]
+  '
+  desc "Removes a given type"
+  task :remove_type, [:name] => :environment do |t, args|
+    if !args.name
+      raise "There are missing some arguments"
+    else
+      type_string = "type = Type.find_by_name( \'#{args.name}\' )\n"
+      type_string = type_string + "if type.badges.empty?
+        type.destroy
+      else
+        raise \'Aborted! There are badges related with this type.\'
+      end\n"
+    end
+    type_string = type_string + "puts \'> Type successfully removed\'"
+    eval type_string
+    
+    file_path = "/db/gioco/remove_type_#{args.name}.rb"
+    File.open("#{Rails.root}#{file_path}", "w") { |f| f.write type_string }
+    File.open("#{Rails.root}/db/gioco/db.rb", "a") { |f| f.write "require \\"\\#\\{Rails.root\\}#{file_path}\\"\n" }
+  end
+  '
+end
+}  
+end
+        EOS
+      end     
+  end
+end

data/lib/generators/gioco/setup_generator.rb

@@ -1,181 +1,34 @@
-module Gioco
+require "generators/gioco/model_generator"
+require "generators/gioco/rakes_generator"
+require "generators/gioco/migrations_generator"
+require "generators/gioco/generator_instructions"
+
+class Gioco
+  class SetupGenerator < Rails::Generators::Base
+    include ModelGenerator
+    include RakesGenerator
+    include MigrationsGenerator
+    include GeneratorInstructions
 
-  class SetupGenerator < Rails::Generators::NamedBase
     source_root File.expand_path("../../templates", __FILE__)
     
     desc "Setup Gioco for some resource"
     class_option :points, :type => :boolean, :default => false, :desc => "Setup gioco with points-system based"
     class_option :types, :type => :boolean, :default => false, :desc => "Setup gioco with multiples types(categories) of badges."
 
-    def generate_models
-      generate("model", "level badge_id:integer #{file_name}_id:integer")
-      if options[:types]
-        generate("model", "point user_id:integer type_id:integer value:integer")
-        generate("model", "type name:string") 
-        generate("model", "badge name:string type_id:integer  #{(options[:points]) ? "points:integer" : ""} default:boolean")
-      else
-        generate("migration", "add_points_to_#{file_name.pluralize} points:integer") if options[:points]
-        generate("model", "badge name:string #{(options[:points]) ? "points:integer" : ""} default:boolean")
-      end
-    end
-
-    def creating_templates
-      @points = ( options[:points] ) ? true : false
-      @types = ( options[:types] ) ? true : false
-      template "gioco.rb", "config/initializers/gioco.rb"
-    end
 
-    def setup_relations
-      add_relationship( "badge", "levels", "has_many", false, "destroy" )
-      add_relationship( "badge", file_name.pluralize, "has_many", "levels" )
-      
-      add_relationship( file_name, "levels", "has_many" )
-      add_relationship( file_name, "badges", "has_many", "levels" )
-
-      add_relationship( "level", file_name, "belongs_to" )
-      add_relationship( "level", "badge", "belongs_to" )
-
-      if options[:types]
-        add_relationship( file_name, "points", "has_many" )
-        add_relationship( "type", "points", "has_many" )
-        add_relationship( "type", "badges", "has_many" )
-        add_relationship( "badge", "type", "belongs_to" )
-        add_relationship( "point", file_name, "belongs_to" )
-        add_relationship( "point", "type", "belongs_to" )
-      end
+    def execute
+      @model_name = ask("What is your resource model? (eg. user)")
+      generate_models
+      creating_templates
+      adding_methods
+      add_validations
+      setup_relations
+      create_rakes
+      configuring_seed
+      migrating
+      instructions
     end
-
-    def create_rakes
-      rakefile("gioco.rake") do
-        <<-EOS
-# -*- encoding: utf-8 -*-
-namespace :gioco do
   
-  desc "Used to add a new badge at Gioco scheme"
-  
-  task :add_badge, [:name, #{":points, " if options[:points]}#{":type, " if options[:types]}:default] => :environment do |t, args|
-    args.default = ( args.default ) ? eval(args.default) : false
-
-
-    if !args.name #{"&& !args.points" if options[:points]}#{" && !args.type" if options[:types]}
-      puts "There are missing some arguments"
-    
-    else
-      #{"type = ( Type.find_by_name(args.type) ) ? Type.find_by_name(args.type) : Type.create({ :name => args.type })" if options[:types]}
-
-      badge = Badge.create({ 
-                            :name => args.name, 
-                            #{":points => args.points," if options[:points]}
-                            #{":type_id  => type.id," if options[:types]}
-                            :default => args.default
-                          })
-
-      if args.default
-        resources = #{file_name.capitalize}.find(:all)
-        resources.each do |r|
-          #{
-          if options[:points] && options[:types]
-            "r.points  << Point.create({ :type_id => type.id, :value => args.points })"
-          elsif options[:points]
-            "r.points = args.points"
-          end
-          }
-          r.badges << badge
-          r.save!
-        end
-      end
-
-    end
-
-  end
-
-  desc "Used to remove an old badge at Gioco scheme"
-
-  task :remove_badge, [:name] => :environment do |t, args|
-
-    if !args.name
-      puts "There are missing some arguments"
-    
-    else
-      badge = Badge.find_by_name( args.name )
-      badge.destroy
-    end
-
-  end
-#{
-  if options[:types]
-    'task :remove_type, [:name] => :environment do |t, args|
-
-      if !args.name
-        puts "There are missing some arguments"
-      
-      else
-        type = Type.find_by_name( args.name )
-        
-        if type.badges.nil?
-          type.destroy
-        else
-          puts "Aborted! There are badges related with this type."
-        end
-      end
-    end'
   end
-}  
-end
-        EOS
-      end
-    end
-
-    def migrating
-      puts <<-EOS
-
-=======================================
-> Now is time to run rake db:migrate
-=======================================
-
-      EOS
-      rake("db:migrate")
-    end
-
-    def instructions
-      puts <<-EOS
-
-=======================================================
-
-Gioco successfully installed.
-
-Now you are able to add Badges using:
-  rake gioco:add_badge[BADGE_NAME#{",POINTS" if options[:points]}#{",TYPE" if options[:types]},DEFAULT]
-
-To remove Badges using:
-  rake gioco:remove_badge[BADGE_NAME]
-
-#{
-  if options[:types]
-"And to remove Types using:
-  rake gioco:remove_type[TYPE_NAME]"
-  end
-}
-
-For usage and more infomation go to the documentation:
-http://joaomdmoura.github.com/gioco/
-
-=======================================================
-
-      EOS
-    end
-    
-    private
-
-    def add_relationship ( model, related, relation, through = false, dependent = false )
-      gsub_file "app/models/#{model}.rb", get_class_header(model), "#{get_class_header(model)}
-      #{relation} :#{related} #{(through) ? ", :through => :#{through}" : ""} #{(dependent) ? ", :dependent => :#{dependent}" : ""}"
-    end
-
-    def get_class_header ( model_name )
-      "class #{model_name.capitalize} < ActiveRecord::Base"
-    end
-
-  end
-
 end

data/lib/generators/templates/badge.rb

@@ -0,0 +1,32 @@
+def add(resource_id)
+  resource = Gioco::Core.get_resource(resource_id)
+
+  if Gioco::Core::POINTS && !resource.badges.include?(self)
+    if Gioco::Core::TYPES
+      Gioco::Core.sync_resource_by_points(resource, self.points, self.type)
+    else
+      Gioco::Core.sync_resource_by_points(resource, self.points)
+    end
+  elsif !resource.badges.include?(self)
+    resource.badges << self
+    return self
+  end
+end
+
+def remove(resource_id)
+  resource = Gioco::Core.get_resource(resource_id)
+
+  if Gioco::Core::POINTS && resource.badges.include?(self)
+    if Gioco::Core::TYPES
+      type       = self.type
+      badges_gap = Badge.where( "points < #{self.points} AND type_id = #{type.id}" ).order('points DESC')[0]
+      Gioco::Core.sync_resource_by_points( resource, ( badges_gap.nil? ) ? 0 : badges_gap.points, type)
+    else
+      badges_gap = Badge.where( "points < #{self.points}" ).order('points DESC')[0]
+      Gioco::Core.sync_resource_by_points( resource, ( badges_gap.nil? ) ? 0 : badges_gap.points)
+    end
+  elsif resource.badges.include?(self)
+    resource.levels.where( :badge_id => self.id )[0].destroy
+    return self
+  end
+end

data/lib/generators/templates/gioco.rb

@@ -1,3 +1,3 @@
-Gioco::Core::RESOURCE_NAME  = "<%= file_name %>"
+Gioco::Core::RESOURCE_NAME  = "<%= @model_name %>"
 Gioco::Core::POINTS         = <%= @points %>
 Gioco::Core::TYPES          = <%= @types %>

data/lib/generators/templates/resource.rb

@@ -0,0 +1,41 @@
+def change_points(options)
+  if Gioco::Core::TYPES
+    type_id = options[:type]
+    points  = options[:points]
+  else
+    points  = options
+  end
+  type      = (type_id) ? Type.find(type_id) : false
+
+  if Gioco::Core::TYPES
+    raise "Missing Type Identifier argument" if !type_id
+    old_pontuation  = self.points.where(:type_id => type_id).sum(:value)
+  else
+    old_pontuation  = self.points.to_i
+  end
+  new_pontuation    = old_pontuation + points
+  Gioco::Core.sync_resource_by_points(self, new_pontuation, type)
+end
+
+def next_badge?(type_id = false)
+  type              = (type_id) ? Type.find(type_id) : false
+  if Gioco::Core::TYPES
+    raise "Missing Type Identifier argument" if !type_id
+    old_pontuation  = self.points.where(:type_id => type_id).sum(:value)
+  else
+    old_pontuation  = self.points.to_i
+  end
+  next_badge       = Badge.where("points > #{old_pontuation}").order("points ASC").first
+  last_badge_point = self.badges.last.try('points')
+  last_badge_point ||= 0
+
+  if next_badge
+    percentage      = (old_pontuation - last_badge_point)*100/(next_badge.points - last_badge_point)
+    points          = next_badge.points - old_pontuation
+    next_badge_info = { 
+                        :badge      => next_badge,
+                        :points     => points,
+                        :percentage => percentage
+                      }
+  end
+end

data/lib/gioco.rb

@@ -1,6 +1,4 @@
-module Gioco
+class Gioco
   require "gioco/core"
-  require "gioco/resources"
-  require "gioco/badges"
   require "gioco/rankings"
 end

data/lib/gioco/core.rb

@@ -1,4 +1,4 @@
-module Gioco
+class Gioco
   class Core
     def self.get_resource(rid)
       RESOURCE_NAME.capitalize.constantize.find(rid)
@@ -6,29 +6,37 @@ module Gioco
 
     def self.sync_resource_by_points(resource, points, type = false)
 
+      badges = {}
       if TYPES && type
         old_pontuation  = resource.points.where(:type_id => type.id).sum(:value)
-        related_badges  = Badge.where( ((old_pontuation < points) ? "points <= #{points}" : "points > #{points} AND points <= #{old_pontuation}") + " AND type_id = #{type.id}" )
+        related_badges  = Badge.where(((old_pontuation < points) ? "points <= #{points}" : "points > #{points} AND points <= #{old_pontuation}") + " AND type_id = #{type.id}")
       else
         old_pontuation  = resource.points.to_i
-        related_badges  = Badge.where((old_pontuation < points) ? "points <= #{points}" : "points > #{points} AND points <= #{old_pontuation}" )
+        related_badges  = Badge.where((old_pontuation < points) ? "points <= #{points}" : "points > #{points} AND points <= #{old_pontuation}")
       end
       
-      new_pontuation    = ( old_pontuation < points ) ? points :  - (old_pontuation - points)
+      new_pontuation    = ( old_pontuation < points ) ? points - old_pontuation : - (old_pontuation - points)
 
       Badge.transaction do
         if TYPES && type
-          resource.points  << Point.create({ :type_id => type.id, :value => new_pontuation })
-        elsif options[:points]
-          resource.update_attribute( :points, new_pontuation )
+          resource.points << Point.create({ :type_id => type.id, :value => new_pontuation })
+        elsif POINTS
+          resource.update_attribute( :points, points )
         end
         related_badges.each do |badge|
           if old_pontuation < points
-            resource.badges << badge if !resource.badges.include?(badge)
+            if !resource.badges.include?(badge)
+              resource.badges << badge
+              badges[:added] = [] if badges[:added].nil?
+              badges[:added] << badge
+            end
           elsif old_pontuation > points
             resource.levels.where( :badge_id => badge.id )[0].destroy
+            badges[:removed] = [] if badges[:removed].nil?
+            badges[:removed] << badge
           end
         end
+        badges
       end
     end
     

data/lib/gioco/rankings.rb

@@ -1,4 +1,4 @@
-module Gioco
+class Gioco
   class Ranking < Core
 
      def self.generate

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gioco
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -20,12 +20,16 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/gioco.rb
+- lib/generators/gioco/generator_instructions.rb
+- lib/generators/gioco/migrations_generator.rb
+- lib/generators/gioco/model_generator.rb
+- lib/generators/gioco/rakes_generator.rb
 - lib/generators/gioco/setup_generator.rb
+- lib/generators/templates/badge.rb
 - lib/generators/templates/gioco.rb
-- lib/gioco/badges.rb
+- lib/generators/templates/resource.rb
 - lib/gioco/core.rb
 - lib/gioco/rankings.rb
-- lib/gioco/resources.rb
 - init.rb
 homepage: http://joaomdmoura.github.com/gioco/
 licenses: []

data/lib/gioco/badges.rb

@@ -1,36 +0,0 @@
-module Gioco
-  class Badges < Core
-    def self.add(rid, badge_id)
-      resource        = get_resource( rid )
-      badge           = Badge.find( badge_id )
-
-      if POINTS && !resource.badges.include?(badge)
-        if TYPES
-          sync_resource_by_points( resource, badge.points, badge.type)
-        else
-          sync_resource_by_points( resource, badge.points)
-        end
-      elsif !resource.badges.include?(badge)
-        resource.badges << badge
-      end
-    end
-
-    def self.remove( rid, badge_id )
-      resource  = get_resource( rid )
-      badge     = Badge.find( badge_id )
-      type      = badge.type
-
-      if POINTS && resource.badges.include?(badge)
-        if TYPES
-          badges_gap = Badge.where( "points < #{badge.points} AND type_id = #{type.id}" )[0]
-          sync_resource_by_points( resource, ( badges_gap.nil? ) ? 0 : badges_gap.points, type)
-        else
-          badges_gap = Badge.where( "points < #{badge.points}" )[0]
-          sync_resource_by_points( resource, ( badges_gap.nil? ) ? 0 : badges_gap.points)
-        end
-      elsif resource.badges.include?(badge)
-        resource.levels.where( :badge_id => badge.id )[0].destroy
-      end
-    end
-  end
-end

data/lib/gioco/resources.rb

@@ -1,15 +0,0 @@
-module Gioco
-  class Resources < Core
-    def self.change_points( rid, points, tid = false )
-      resource          = get_resource( rid )
-      type              = ( tid ) ? Type.find(tid) : false
-      if TYPES && tid
-        old_pontuation  = resource.points.where(:type_id => tid).sum(:value)
-      else
-        old_pontuation  = resource.points.to_i
-      end
-      new_pontuation    = old_pontuation + points
-      sync_resource_by_points(resource, new_pontuation, type)
-    end
-  end
-end