ludy 0.1.9 → 0.1.10

data/CHANGES

@@ -1,12 +1,22 @@
 = ludy changes history
 
+== ludy 0.1.10, 2008.02.07
+
+* fixed an offset bug in paginator. if the offset was equal to the count,
+  there should be no page existed.
+* fixed and updated rdoc presentation
+* fixed a warning of shadowing variables in ruby 1.9
+
+* added the offset test in test_paginator
+* make some Kernel method private
+
 == ludy 0.1.9, 2008.02.07
 
 * fixed a bug in RailsPaginator, which ignored opts for count.
 * fixed a possible bug in puzzle_generator... (not happened before?)
 * fixed a stupid timeout message bug...
 
-* added multiruby test (from ZenTest) with ruby 1.8.6-p111, 1.9.0-0, svn
+* added multiruby test (from ZenTest) with ruby 1.8.6-p111, 1.9.0-0, svn trunk
 * added Array#head, Array#choice!, Array#count
 * added Array#product, which came from ruby 1.9 (implemented by combos in ruby 1.8)
 * added Kernel#deep_copy, by Marshal idiom

data/README

@@ -1,9 +1,8 @@
-= ludy 0.1.9
-    by Lin Jen-Shin (a.k.a. godfat 真常)
-    strip any number: 18god29fat7029 (at] godfat32 -dooot- 20org
-    http://ludy.rubyforge.org
-    http://rubyforge.org/projects/ludy
-    http://godfat.org
+= ludy 0.1.10
+by Lin Jen-Shin (a.k.a. godfat-真常[http://godfat.org])
+  strip any number: 18god29fat7029 (at] godfat32 -dooot- 20org
+* rdoc[http://ludy.rubyforge.org]
+* rubyforge-project[http://rubyforge.org/projects/ludy]
 
 == DESCRIPTION:
 

data/lib/ludy.rb

@@ -9,7 +9,7 @@ end
 module Ludy
 
   # :stopdoc:
-  VERSION = '0.1.9'
+  VERSION = '0.1.10'
   LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
   PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
   $LOAD_PATH << LIBPATH

data/lib/ludy/array/body.rb

@@ -1,8 +1,8 @@
 
 class Array
   # strip the last element
-  #   [1,2,3].body
-  #   => [1,2]
+  #  [1,2,3].body
+  #  => [1,2]
   def body
     self[0..-2]
   end

data/lib/ludy/array/combine.rb

@@ -2,15 +2,16 @@
 require 'ludy/symbol/to_proc' if RUBY_VERSION < '1.9.0'
 
 class Array
-  #   [1,2,3].combine [2,4,6]
-  #   => [3,6,9]
+  # example:
+  #  [1,2,3].combine [2,4,6]
+  #  => [3,6,9]
   #
-  #   [1,2].combine [1,2], [1,2]
-  #   => [3,6]
+  #  [1,2].combine [1,2], [1,2]
+  #  => [3,6]
   #
-  #   ['a','b'].combine ['b','a']
-  #   => ['ab','ba']
+  #  ['a','b'].combine ['b','a']
+  #  => ['ab','ba']
   def combine *target; zip(*target).map{|i|i.inject(&:+)}; end
-  # in-place version of combine
+  # inplace version of combine
   def combine! *target; replace combine(*target); end
 end

data/lib/ludy/array/combos.rb

@@ -4,8 +4,8 @@ class Array
     require 'ludy/array/foldr'
     require 'ludy/symbol/to_proc' if RUBY_VERSION < '1.9.0'
     # for each combos
-    #   [[0,1],[2,3]].combos
-    #   => [[0,2],[0,3],[1,2],[1,3]]
+    #  [[0,1],[2,3]].combos
+    #  => [[0,2],[0,3],[1,2],[1,3]]
     def combos
       result = []
       radixs = reverse.map(&:size)
@@ -22,9 +22,10 @@ class Array
   else
     require 'ludy/array/tail'
     # for each combos
-    #   [[0,1],[2,3]].combos
-    #   => [[0,2],[0,3],[1,2],[1,3]]
-    # simply: array.first.product *array.tail
+    #  [[0,1],[2,3]].combos
+    #  => [[0,2],[0,3],[1,2],[1,3]]
+    # simply:
+    #  array.first.product *array.tail
     def combos
       first.product(*tail)
     end

data/lib/ludy/array/map_with_index.rb

@@ -1,5 +1,6 @@
 
 class Array
+  # just like each_with_index
   def map_with_index
     i = -1
     map{ |e| i+=1; yield e, i; }

data/lib/ludy/array/rotate.rb

@@ -14,7 +14,7 @@ class Array
     return self if empty? or n == 0
     self[-n..-1] + self[0...-n]
   end
-  # in-place version of rotate
+  # inplace version of rotate
   def rotate!
     replace rotate
   end

data/lib/ludy/array/tail.rb

@@ -1,6 +1,7 @@
 
 class Array
-  # simply array[1..-1]
+  # simply call
+  #  array[1..-1]
   def tail
     self[1..-1]
   end

data/lib/ludy/dices.rb

@@ -3,6 +3,7 @@ module Ludy
 
   # dices, e.g., 4d6, 2d20, etc.
   class Dices
+    # dices amounts of this dices; faces of this kind of dice
     attr_reader :amounts, :faces
     # the default dice is 1d20
     def initialize amounts = 1, faces = 20
@@ -21,6 +22,7 @@ module Ludy
 
   # a dice set could contain 4d6 + 2d20 and more dices.
   class DiceSet
+    # the min and max possible value of this dice set.
     attr_reader :min, :max
     def initialize *args
       @diceset = args

data/lib/ludy/kernel/deep_copy.rb

@@ -1,5 +1,7 @@
 
 module Kernel
+  # common idiom for:
+  #  Marshal::load(Marshal::dump(self))
   def deep_copy
     Marshal::load(Marshal::dump(self))
   end

data/lib/ludy/kernel/maybe.rb

@@ -1,5 +1,8 @@
 
 module Kernel
+  private
+  # return true or false
+  #  simply call rand(2) == 0
   def maybe
     rand(2) == 0
   end

data/lib/ludy/paginator.rb

@@ -10,6 +10,7 @@ module Ludy
   # call Page#fetch
   class Page
     undef_method :to_a if RUBY_VERSION < '1.9.0'
+    # pager to get the original pager; page to get the number of this page
     attr_reader :pager, :page
     # don't create a page instance yourself unless you have to
     def initialize pager, page; @pager, @page = pager, page; end
@@ -72,7 +73,7 @@ module Ludy
     # nil would be returned. note, page start at 1, not zero.
     def page page
       offset = (page-1)*@per_page
-      return nil unless page > 0 and offset <= count
+      return nil unless page > 0 and offset < count
       Page.new self, page
     end
     # return the amount of pages
@@ -93,8 +94,8 @@ module Ludy
   # they would be used in find options. e.g.,
   #  RailsPaginator.new Model, :order => 'created_at DESC'
   # would invoke Model.find :all, :offset => ?, :limit => ?, order => 'created_at DESC'
-  # TODO: conditions/options invoker...
   class RailsPaginator < Paginator
+    # the model class that you passed in this paginator
     attr_reader :model_class
     def initialize model_class, opts = {}
       @model_class = model_class
@@ -112,6 +113,7 @@ module Ludy
   # and create pages simply for your_data[offset, per_page]
   # if your data is much more complex, use Paginator instead of this
   class ArrayPaginator < Paginator
+    # data that you passed in this paginator
     attr_reader :data
     def initialize data
       @data = data

data/lib/ludy/proc/curry.rb

@@ -12,7 +12,7 @@ class Proc
   def curry
     class << self
       alias_method :__call__, :call
-      def call *args, &block
+      def call *args, &block # :nodoc:
         if self.arity == -1
           begin # let's try if arguments are ready
             # is there any better way to determine this?

data/lib/ludy/tasks/preprocess_cpp.rb

@@ -53,8 +53,10 @@ namespace :preprocess do
 
     erubis_inputs.zip(erubis_outputs).each{ |input, output|
       file output => input do
-        class ErboutEruby < Erubis::Eruby; include Erubis::ErboutEnhancer; end
-        preprocess lambda{|input| ErboutEruby.new input, :trim => false}, input, output
+        class ErboutEruby < Erubis::Eruby #:nodoc:
+          include Erubis::ErboutEnhancer
+        end
+        preprocess lambda{|in_str| ErboutEruby.new in_str, :trim => false}, input, output
       end
     }
   rescue LoadError; end # no erubis

data/lib/ludy/tasks/preprocess_cpp/debug_hook.rb

@@ -2,11 +2,27 @@
 require 'ludy/tasks/common'
 
 module Kernel
+  # it simply output:
+  #  #ifndef NDEBUG
+  #  #include <iostream>
+  #  #endif
   def debug_include
 '#ifndef NDEBUG
 #include <iostream>
 #endif'
   end
+  # example usage:
+  #  void <% debug_hook 'C::f' do %>(){
+  #    <% end %>
+  #    std::cout << "hello" << std::endl;
+  #  }
+  # became:
+  #  void C::f(){
+  #    #ifndef NDEBUG
+  #    std::cerr << "method C::f called, for " << this << " at c.cpp: 12\n"
+  #    #endif
+  #    std::cout << "hello" << std::endl;
+  #  }
   def debug_hook name, &block
     Ludy::erbout name, block.binding
     block.call

data/lib/ludy/timer.rb

@@ -4,6 +4,7 @@ module Ludy
   class Timeout < Exception; end
   # simple and stupid timer for puzzle_generator...
   class Timer
+    # create a timer for timeout seconds.
     def initialize timeout
       @timeout = timeout
     end

data/lib/puzzle_generator.rb

@@ -9,15 +9,31 @@ require 'ludy/hash/reverse_merge'
 # require 'facets/timer'
 require 'ludy/timer' # simple and stupid timer....
 
+# puzzle generator for shooting-cubes[http://shooting-cubes.googlecodes.com],
+# example usage:
+#  PuzzleGenerator.debug = true
+#  pg = PuzzleGenerator::Puzzle.new :level => 4, :timeout => 2, :invoke_max => 5
+#  begin
+#    pg.generate
+#    pg.display_map
+#  rescue Ludy::Timeout => e
+#    puts e
+#  ensure
+#    p pg.tried_times
+#    p pg.tried_duration
+#  end
 module PuzzleGenerator
 
-  def self.generate_chained_map option = {}; generate_klass ChainedMap, option; end
-  def self.generate_klass klass, option = {}
+  def self.generate_chained_map option = {} #:nodoc:
+    generate_klass ChainedMap, option
+  end
+  def self.generate_klass klass, option = {} #:nodoc:
     option.reverse_merge! :timeout => 5
     generate(option[:timeout]){ klass.new option }
   end
 
-  LastTriedInfo = {}
+  LastTriedInfo = {} # :nodoc:
+  # generate someing with generator with timeout, used in Puzzle#generate
   def self.generate timeout = 5, &generator
     timer = Ludy::Timer.new(timeout).start
     tried_times = 1

data/lib/puzzle_generator/map.rb

@@ -6,10 +6,6 @@ require 'ludy/kernel/maybe'
 require 'ludy/array/count' if RUBY_VERSION < '1.9.0'
 require 'ludy/array/product' if RUBY_VERSION < '1.9.0'
 
-# a = [[1,2],[3,4],[5,6]]
-# [a, [1,2,3]].combos
-# => [[[1, 2], 1], [[1, 2], 2], [[1, 2], 3], [[3, 4], 1], [[3, 4], 2], [[3, 4], 3], [[5, 6], 1], [[5, 6], 2], [[5, 6], 3]]
-
 module PuzzleGenerator
 
   class Map # :nodoc:

data/lib/puzzle_generator/misc.rb

@@ -3,13 +3,15 @@ require 'ludy/kernel/deep_copy'
 require 'ludy/array/pad'
 
 module PuzzleGenerator
-  Up, Right, Left = (0..2).to_a
+  Up, Right, Left = (0..2).to_a # :nodoc:
   DefaultOption = {:width => 6, :height => 10, :level => 4, :colors => 4,
                    :invoke => 3, :invoke_max => 5, :timeout => 5}
   # whenever the generation is falied, this exception would raise
   class GenerationFailed < RuntimeError; end
   class << self
+    # specify whether to show the answer in the puzzle
     attr_writer :debug
+    # specify whether to show the answer in the puzzle
     def debug; @debug || false; end
   end
 

data/lib/puzzle_generator/puzzle.rb

@@ -10,10 +10,13 @@ module PuzzleGenerator
   class Puzzle
     include DisplayMap
     attr_reader :tried_times, :tried_duration
+    # create a puzzle with option. this won't start generating,
+    # call Puzzle::generate to start generating.
     def initialize option = {}
       @option = DefaultOption.merge option
       @tried_times, @tried_duration = [0, 0], [0, 0]
     end
+    # start generate a puzzle with options that created this puzzle instance.
     def generate
       raw_colors = (1..@option[:colors]).to_a
       step_colors = raw_colors.rotate
@@ -35,7 +38,7 @@ module PuzzleGenerator
     end
 
     private
-    Chain, Color = 0, 1
+    Chain, Color = 0, 1 # :nodoc:
     def make_chain
       begin
         @result_chain =

data/test/ludy/test_paginator.rb

@@ -47,6 +47,14 @@ class TestPaginator < Test::Unit::TestCase
     })
     for_pager pager
   end
+  def test_offset_bug
+    a = (0..9).to_a
+    pager = ArrayPaginator.new a
+    pager.per_page = 5
+    assert_equal 5, pager[1].size
+    assert_equal 5, pager[2].size
+    assert_nil pager[3]
+  end
   class Topic
     class << self
       def count opts = {}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ludy
 version: !ruby/object:Gem::Version 
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors: 
 - "Lin Jen-Shin (a.k.a. godfat \xE7\x9C\x9F\xE5\xB8\xB8)"