dummy_urls 0.9

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.9 (August 10, 2010)
+
+Features:
+  - generating routes for Rails 3 applications by using dummy (functionality split up from old project)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Gonçalo Silva
+
+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,52 @@
+# Dummy routes
+
+"Dummy urls" uses [dummy](http://github.com/goncalossilva/dummy) to generate test urls for your Rails 3 application.
+
+## Description
+
+"Dummy urls" generates GET, POST, PUT and DELETE test urls for your Rails 3 application. It depends on [dummy\_data](http://github.com/goncalossilva/dummy_data) since it expects you to generate your test data with it (you can change it later). It also uses [dummy](http://github.com/goncalossilva/dummy) to generate the needed data for POST and PUT requests. Check dummy's description for a better understanding of what it does.
+
+## Installation
+
+$ gem install dummy_urls
+
+## Usage
+
+Add the following to the Gemfile of your Rails 3 application:
+    gem "dummy_urls"
+    
+Now you have access to the generator:
+    rails generate dummy:urls
+    
+You can change the divisor in use (what these mean exactly is explained latter on):
+    rails generate dummy:urls --divisor=3
+    
+Also, you can manually define the amount of urls to generate for each model (or just accept the defaults):
+    rails generate dummy:urls --manual-amounts
+    
+And you can manually set the output folder of the dummy data (which defaults to test/dummy):
+    rails generate dummy:urls --output-folder test/awesome_fixtures
+
+The files will be placed under _output-folder_/urls.
+    
+Feel free to mix all of these options.
+
+## More information
+
+### URLs with smart data
+
+"Dummy urls" tells dummy to try to understand your database columns and generate data accordingly, instead of dumping "Lorem ipsum" all over the place.
+
+For instance, if you have a field called _company\_name_, it will generate a company name. If you have a field called _awesome\_postal\_code_, it will generate a valid ZIP Code. If you have a field called _longitude_, it will generate a valid longitude, and so on. You get the picture.
+
+Dummy cares about associations. It will create random associations between the automatically generated records, so you don't have to worry about that.
+
+This way, the generated POST and PUT requests will look very realistic.
+
+### Smart amounts of urls
+
+"Dummy urls" analyzes the amount of records that dummy\_data generated and uses this amount to estimate the amount of url groups to generate (each group composed by a GET, a POST, a PUT and a DELETE request).
+
+It uses the divisor for this estimation. If dummy\_data generated 15 records for a given model and dummy\_urls is using the default divisor (5), it will generate 3 groups of urls for this model (12 requests in total).
+
+Copyright (c) 2010 Gonçalo Silva

data/lib/dummy_urls.rb

@@ -0,0 +1,10 @@
+require "rubygems"
+require "dummy"
+require "dummy_data"
+require "generators/urls/urls_generator"
+
+module Dummy
+  module Generators
+    class MissingDummyfile < RuntimeError; end
+  end
+end

data/lib/generators/urls/templates/model.yml

@@ -0,0 +1,25 @@
+<%= "# '#{@model_name}' urls generated automatically by dummy at #{Time.now.strftime("%H:%M %m/%d/%Y")} (#{@url_amount} groups of urls)." %>
+<% for i in 1..@url_amount do %>
+<% id = generate_id(@model_name) -%>
+get_<%= i %>:
+  type: get
+  url: /<%= @model_name %>/<%= id %>
+
+post_<%= i %>:
+  type: post
+  url: /<%= @model_name %>/new
+  params:
+    :<%= @model_name.singularize %>:
+      <%= generate_data(@model_name).map { |field, value| "#{field}: #{value}" }.join("\n      ") %>
+
+put_<%= i %>:
+  type: put
+  url: /<%= @model_name %>/<%= id %>
+  params:
+    :<%= @model_name.singularize %>:
+      <%= generate_data(@model_name).map { |field, value| "#{field}: #{value}" }.join("\n      ") %>
+
+delete_<%= i %>:
+  type: delete
+  url: /<%= @model_name %>/<%= id %>
+<% end %>

data/lib/generators/urls/urls_generator.rb

@@ -0,0 +1,130 @@
+module Dummy
+  module Generators    
+    class UrlsGenerator < Rails::Generators::Base
+      include Dummy::Generators::Common
+            
+      def self.source_root
+        @source_root ||= File.expand_path("../templates", __FILE__)
+      end
+      
+      class_option :divisor, :type => :numeric, :default => 10,
+                  :desc => "The divisor to use when determining the amount of urls to generate."
+      class_option :manual_amounts, :type => :boolean, :default => false,
+                  :desc => "Manually set the amount of urls to generate for each model."
+      class_option :output_folder, :type => :string, :default => "test/dummy",
+                  :desc => "Dummy output folder, urls/ will be used when storing the resulting YAML files."      
+
+      def install_dummy_urls
+        initialize_application
+        generate_dummy_urls
+        copy_rake_files
+        update_dummyfile
+      end
+      
+    private
+
+      def initialize_application
+        require File.expand_path("#{Rails.root}/config/environment.rb")
+        say_status :successful, "initialize Rails application"
+      end
+      
+      def generate_dummy_urls
+        get_table_names
+        load_dummyfile
+        predict_url_amounts
+        gather_associations
+      end
+      
+      def get_table_names
+        @models = Hash.new
+        Dir["app/models/*.rb"].each do |full_path|
+          model = File.basename(full_path).chomp(File.extname(full_path)).camelcase.constantize
+          @models.merge!({model => {
+            :record_amount => 0, :url_amount => 0, :associations => []
+          }}) if model.respond_to?(:columns)
+        end
+      end
+      
+      def load_dummyfile
+        begin
+          records = YAML.load_file "#{options.output_folder}/Dummyfile"
+        rescue
+          raise MissingDummyfile, "Could not find the Dummyfile. Did you forget to generate dummy data or specified a different directory?"
+        end
+        
+        records.each do |record, amount|
+          model = record.singularize.camelcase.constantize
+          @models[model][:record_amount] = amount[:records]
+        end        
+      end
+      
+      def predict_url_amounts
+        @models.each do |model, data|
+          amount = data[:record_amount] / options.divisor
+          
+          if options.manual_amounts
+            user_defined = ask("Number of urls for #{model} (default: #{amount}): ")
+            amount = user_defined unless user_defined.empty?
+          end
+          
+          @models[model][:url_amount] = amount.to_i
+        end
+      end
+      
+      def copy_rake_files
+        empty_directory "test/dummy/urls"
+        @models.each do |model, info|
+          @generated_ids = Array.new
+          
+          @model_name = model.to_s.underscore.pluralize
+          @url_amount = info[:url_amount]
+          template "model.yml", "#{options.output_folder}/urls/#{@model_name}.yml"
+        end
+      end
+      
+      def generate_id(model_name)
+        model = model_name.singularize.camelcase.constantize
+        
+        begin
+          yaml_id = rand(@models[model][:record_amount])
+        end while @generated_ids.include?(yaml_id)
+        @generated_ids.push(yaml_id)
+        
+        Fixtures.identify("#{model_name.singularize}_#{yaml_id}")
+      end
+      
+      def generate_data(model_name)
+        data = Hash.new
+        key_value = Hash.new
+        model = model_name.singularize.camelcase.constantize
+        
+        model.columns.each do |column|
+          name = model.to_s.underscore
+          info = @models[model]
+          
+          key_value = generate_record_data(name, info, column, false)
+          data.merge!(key_value) unless key_value.nil?
+        end
+        
+        data
+      end
+      
+      def update_dummyfile
+        data = Hash.new
+        dummyfile_path = "#{options.output_folder}/Dummyfile"
+        
+        @models.each do |model, info|
+          data[model.to_s.underscore.pluralize] = {:records => info[:record_amount],
+                                                  :urls => info[:url_amount]}
+        end
+        
+        content = "# This file was automatically generated by Dummy. Do NOT change it.\n"        
+        content << YAML.dump(data)
+        
+        remove_file dummyfile_path, :verbose => false if File.exists?(dummyfile_path)
+        create_file dummyfile_path, content
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: dummy_urls
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  version: "0.9"
+platform: ruby
+authors: 
+- "Gon\xC3\xA7alo Silva"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-17 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dummy
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: dummy_data
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta
+        version: 3.0.0.beta
+  type: :runtime
+  version_requirements: *id003
+description: Generates dummy URLs to hit Rails 3 applications' routes. Since POST and PUT requests require more information than an URL, it uses dummy to generate appropriate data for these requests
+email: 
+- goncalossilva@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/dummy_urls.rb
+- lib/generators/urls/urls_generator.rb
+- lib/generators/urls/templates/model.yml
+- LICENSE
+- CHANGELOG.md
+- README.md
+has_rdoc: true
+homepage: http://github.com/goncalossilva/dummy_urls
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 7
+      version: 1.3.7
+requirements: []
+
+rubyforge_project: dummy_urls
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generates dummy URLs for Rails 3 applications
+test_files: []
+