webink 1.3.2 → 1.3.3

data/bin/rfcgi

@@ -48,6 +48,9 @@ FCGI.each_cgi do |cgi|
     control[:config] = Ink::Beauty.load_config script
     control[:time] = time
     control[:cgi] = cgi
+    control[:env] = ENV
+    control[:is_production] = is_production
+    control[:use_errors] = use_errors
     if cgi.env_table['REQUEST_METHOD'] == 'POST'
       control[:post] = Hash.new
       cgi.params.each do |k,v|
@@ -75,7 +78,7 @@ FCGI.each_cgi do |cgi|
     fhandle.close
     
   rescue LoadError => bang
-    if not is_production
+    if is_production
       puts cgi.header({"Location" => "/status-404.html"}) if use_errors
       error cgi, "NOT_FOUND" if not use_errors
     else
@@ -84,7 +87,7 @@ FCGI.each_cgi do |cgi|
     end
     
   rescue NotImplementedError => bang
-    if not is_production
+    if is_production
       puts cgi.header({"Location" => "/status-500.html"}) if use_errors
       error cgi, "SERVER_ERROR" if not use_errors
     else
@@ -93,7 +96,7 @@ FCGI.each_cgi do |cgi|
     end
     
   rescue ArgumentError => bang
-    if not is_production
+    if is_production
       puts cgi.header({"Location" => "/status-500.html"}) if use_errors
       error cgi, "SERVER_ERROR" if not use_errors
     else
@@ -102,7 +105,7 @@ FCGI.each_cgi do |cgi|
     end
     
   rescue RuntimeError => bang
-    if not is_production
+    if is_production
       puts cgi.header({"Location" => "/status-500.html"}) if use_errors
       error cgi, "SERVER_ERROR" if not use_errors
     else
@@ -111,7 +114,7 @@ FCGI.each_cgi do |cgi|
     end
   
   rescue NameError => bang
-    if not is_production
+    if is_production
       puts cgi.header({"Location" => "/status-500.html"}) if use_errors
       error cgi, "SERVER_ERROR" if not use_errors
     else
@@ -120,7 +123,7 @@ FCGI.each_cgi do |cgi|
     end
     
   rescue Exception, StandardError => bang
-    if not is_production
+    if is_production
       puts cgi.header({"Location" => "/status-500.html"}) if use_errors
       error cgi, "SERVER_ERROR" if not use_errors
     else

data/lib/webink/controller.rb

@@ -6,12 +6,13 @@ module Ink
   # 
   # Controllers handle incoming requests and decide what to do
   # with them. A controller has access to all incoming data, like
-  # POST and GET as well as the config.
+  # POST and GET (through @params[:get] and @params[:post] as
+  # well as the config.
   #
   #   class App < Ink::Controller
   #     
   #     def index
-  #       redirect_to :controller => "app", :module => "feed", :id => 29382374
+  #       redirect_to :controller => "my_app", :module => "feed", :id => 29382374
   #     end
   #     
   #     def feed
@@ -27,9 +28,11 @@ module Ink
   #     
   #   end
   #
-  # A controller named App should have the filename app.rb and be
-  # placed inside the project controller folder. It can have instance
-  # methods that are usually refered to as modules.
+  # A controller named App should have the filename app.rb (note
+  # that underscores are not allowed: "app".capitalize must be
+  # the loadable classname) and be placed inside the project
+  # controller folder. It can have instance methods that are
+  # usually refered to as modules.
   # So a route should contain at least a :controller and a :module.
   #
   # In the sample above there are three modules, index redirects
@@ -211,8 +214,7 @@ module Ink
     # [returns:] Hyperlink
     def link_to(*args)
       raise ArgumentError.new("Expects an array.") if not args.instance_of? Array and args.length < 2
-      href = "#{@params[:root]}#{(@params[:root][@params[:root].length-1].chr == "/") ? "" : "/"}" if @params[:root].length > 0
-      href = "/" if @params[:root].length == 0
+      href = (@params[:root].length == 0) ? "/" : "#{@params[:root]}#{(@params[:root][@params[:root].length-1].chr == "/") ? "" : "/"}"
       a = "<a "
       name = args[0]
       for i in 1...args.length
@@ -238,8 +240,7 @@ module Ink
     # [param args:] Array of Strings or String
     # [returns:] path
     def path_to(*args)
-      href = "#{@params[:root]}#{(@params[:root][@params[:root].length-1].chr == "/") ? "" : "/"}" if @params[:root].length > 0
-      href = "/" if @params[:root].length == 0
+      href = (@params[:root].length == 0) ? "/" : "#{@params[:root]}#{(@params[:root][@params[:root].length-1].chr == "/") ? "" : "/"}"
       
       if args.is_a? Array
         for i in 0...args.length

data/lib/webink/database.rb

@@ -39,14 +39,20 @@ module Ink
   # This is the most basic query, it returns an Array of results,
   # and each element contains a Hash of column_name => column_entry.
   #
-  #   Ink::Database.database.find "apples", "WHERE id < 10 GROUP BY color"
-  #   => self.query("SELECT * FROM apples WHERE id < 10 GROUP BY color;")
+  # The following methods are convenience methods to access data for
+  # models. As example a model Apple and its n:1 relation to Tree
+  # are used. Please note that both class and database table name can
+  # be used to call the find and related methods. The table name for
+  # Apple would be "apple"; for MyApple would be "my_apple".
+  #
+  #   Ink::Database.database.find "apple", "WHERE id < 10 GROUP BY color"
+  #   => self.query("SELECT * FROM apple WHERE id < 10 GROUP BY color;")
   #
   # This is different from the query method, because it returns an Array
   # of Objects, created by the information stored in the database. So this
   # find() will return you a set of Apple-instances.
   #
-  #   Ink::Database.database.find_union "apple", 5, "tree", ""
+  #   Ink::Database.database.find_union "apple", 5, "tree", "AND tree_id>1"
   #
   # find_union allows you to retrieve data through a many_many reference.
   # When you define a many_many relationship, a helper-table is created
@@ -56,16 +62,30 @@ module Ink
   # by the alphabetically first, and then second classname. The last quotes
   # allow additional query informations to be passed along (like group by)
   #
-  #   Ink::Database.database.find_reference "tree", 1, "apple", ""
+  #   Ink::Database.database.find_references Tree, 1, Apple, "AND tree_id>1"
   #
-  # find_reference is similar to find_union, only that it handles all
+  # find_references is similar to find_union, only that it handles all
   # other relationships. This statement above requires one Tree to have many
   # Apples, so it will return an Array of Apples, all those that belong to
   # the Tree with primary key 1
   #
+  #   Ink::Database.database.find_reference Apple, 5, Tree, ""
+  #
+  # find_reference is essentially equal to find_references, yet it returns
+  # one result of a Tree or nil. This is used when Apple-Tree is a many_one
+  # or one_one relationship. It saves the need for the result Array from
+  # find_references.
+  #
   # Please close the dbinstance once you are done. This is automatically
   # inserted in the init.rb of a project.
   #
+  # == Convenience methods
+  #
+  #   Database.format_date(Time.now)
+  #
+  # This will return a date in the form of 2012-11-20 10:00:02 and takes a Time
+  # instance.
+  #
   # 
   #
   class Database

data/lib/webink/model.rb

@@ -12,7 +12,7 @@ module Ink
   # The constructor checks, if there are class methods 'fields'
   # and 'foreign' defined. If that check is positive, it will
   # match the parameter Hash to the fields, that are set for
-  # the database, and thow an exception if fields is lacking
+  # the database, and throw an exception if fields is lacking
   # an entry (excluded the primary key). The other case just
   # creates an Apple with the Hash as instance variables.
   #
@@ -22,14 +22,12 @@ module Ink
   # methods are automatically added for either the Hash, or
   # the fields and foreign keys.
   #
-  #   apple.tree = nil
   #   apple.save
   #
   # You can save your apple by using the save method. New instances
   # will create a new row in the database, and update its primary
-  # key. Old instances just update the fields. Relationships, like
-  # in the sample below a tree, is set to nil by default, and therefore
-  # the save method will not touch relationships.
+  # key. Old instances just update the fields. Relationships are set
+  # to nil by default and will not be touched while nil.
   #
   #   treeinstance.apple = [1,2,myapple]
   #   treeinstance.save
@@ -47,6 +45,13 @@ module Ink
   # themselves, so you must fetch all related data, and delete them by
   # 'hand' if you will.
   #
+  #   treeinstance.find_references Apple
+  #
+  # This convenience method finds all apples for this tree and makes
+  # them available in the accessor. If the Tree-Apple relationship is
+  # a *_one, then there is only one object in the accessor, otherwise
+  # an Array of objects.
+  #
   #
   # = Fields and foreign sample config
   #
@@ -78,6 +83,37 @@ module Ink
   # many_many, many_one]
   # Obviously the Tree class requires a foreign with "Apple"
   # mapped to "many_one" to match this schema.
+  # 
+  # You can override the automatically generated getters and
+  # setters in any Model class you create by just redefining
+  # the methods.
+  #
+  # == Convenience methods
+  #
+  #   self.primary_key
+  #   self.foreign_key
+  #
+  # Both return an Array of length 2, where the second entry
+  # is the type and the first for primary_key is the name of
+  # the primary key (default "id"). The foreign_key has a
+  # combination of "classname"_"primary_key" (i.e. "apple_id")
+  #
+  #   self.class_name
+  #
+  # Equivalent to class.name
+  #
+  #   self.table_name
+  #
+  # Generates a table representation of the class. (Apple as
+  # "apple" and MyApple as "my_apple")
+  #
+  #   self.str_to_classname(str)
+  #
+  # Converts a table name to class name. This method takes a string.
+  #
+  #   self.str_to_tablename(str)
+  #
+  # Converts a class name to table name. This method takes a string.
   #
   #
   #
@@ -93,7 +129,7 @@ module Ink
     def initialize(data)
       if self.class.respond_to? :fields
         self.class.fields.each do |k,v|
-          raise NameError.new("Model cannot use #{k} as field, it already exists") if self.class.respond_to? k or k.to_s.downcase == "pk"
+          raise NameError.new("Model cannot use #{k} as field, it is blocked by primary key") if k.to_s.downcase == "pk"
           raise LoadError.new("Model cannot be loaded, argument missing: #{k}") if not data.key?(k.to_s) and self.class.primary_key[0] != k
           entry = nil
           if data[k.to_s].nil?
@@ -107,21 +143,25 @@ module Ink
           end
           instance_variable_set("@#{k}", entry)
           
-          self.class.send(:define_method, k) do
-            instance_variable_get "@#{k}"
+          if not self.respond_to? k
+            self.class.send(:define_method, k) do
+              instance_variable_get "@#{k}"
+            end
           end
           if self.class.primary_key[0] != k
-            self.class.send(:define_method, "#{k}=") do |val|
-              if data[k.to_s].nil?
-                val = nil
-              elsif val.is_a? String
-                val = val.gsub(/'/, ''')
-              elsif val.is_a? Numeric
-                val = val
-              else
-                val = "\'#{val}\'"
+            if not self.respond_to? "#{k}="
+              self.class.send(:define_method, "#{k}=") do |val|
+                if data[k.to_s].nil?
+                  val = nil
+                elsif val.is_a? String
+                  val = val.gsub(/'/, ''')
+                elsif val.is_a? Numeric
+                  val = val
+                else
+                  val = "\'#{val}\'"
+                end
+                instance_variable_set "@#{k}", val
               end
-              instance_variable_set "@#{k}", val
             end
           else
             self.class.send(:define_method, "pk") do
@@ -132,13 +172,15 @@ module Ink
         if self.class.respond_to? :foreign
           self.class.foreign.each do |k,v|
             k_table = self.class.str_to_tablename(k)
-            raise NameError.new("Model cannot use #{k_table} as foreign, it already exists") if self.class.respond_to? k_table.to_sym or k_table == "pk"
-            instance_variable_set("@#{k_table}", nil)
-            self.class.send(:define_method, k_table) do
-              instance_variable_get "@#{k_table}"
-            end
-            self.class.send(:define_method, "#{k_table}=") do |val|
-              instance_variable_set "@#{k_table}", val
+            raise NameError.new("Model cannot use #{k_table} as foreign, it already exists") if k_table == "pk"
+            if not self.respond_to? k_table
+              instance_variable_set("@#{k_table}", nil)
+              self.class.send(:define_method, k_table) do
+                instance_variable_get "@#{k_table}"
+              end
+              self.class.send(:define_method, "#{k_table}=") do |val|
+                instance_variable_set "@#{k_table}", val
+              end
             end
           end
         end
@@ -186,7 +228,7 @@ module Ink
       if pkvalue
         response = Ink::Database.database.find self.class, pkvalue
         if response.length == 1
-          Ink::Database.database.query "UPDATE #{self.class.table_name} SET #{string * ","} #{pkvalue}"
+          Ink::Database.database.query "UPDATE #{self.class.table_name} SET #{string * ","} #{pkvalue};"
         elsif response.length == 0
           Ink::Database.database.query "INSERT INTO #{self.class.table_name} (#{keystring * ","}) VALUES (#{valuestring * ","});"
           pk = Ink::Database.database.last_inserted_pk(self.class)
@@ -219,7 +261,7 @@ module Ink
       end
       
       pkvalue = instance_variable_get "@#{self.class.primary_key[0]}"
-      Ink::Database.database.remove self.class.name, "WHERE `#{self.class.primary_key[0]}`=#{(pkvalue.is_a?(Numeric)) ? pkvalue : "\'#{pkvalue}\'"};"
+      Ink::Database.database.remove self.class.name, "WHERE `#{self.class.primary_key[0]}`=#{(pkvalue.is_a?(Numeric)) ? pkvalue : "\'#{pkvalue}\'"}"
     end
     
     # Instance method

metadata

@@ -1,82 +1,85 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: webink
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.3.3
   prerelease: 
-  version: 1.3.2
 platform: ruby
-authors: 
+authors:
 - Matthias Geier
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-10-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: fcgi
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.8.8
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: simple-mmap
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: simple-mmap
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.1.4
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.4
 description: 
 email: 
-executables: 
+executables:
 - webink_database
 - rfcgi
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/webink.rb
-- lib/webink/model.rb
+- lib/webink/controller.rb
 - lib/webink/database.rb
 - lib/webink/beauty.rb
-- lib/webink/controller.rb
-- bin/webink_database
+- lib/webink/model.rb
 - bin/rfcgi
+- bin/webink_database
 homepage: https://github.com/matthias-geier/WebInk
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.9.3
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A minimal web framework.
 test_files: []
-