rails2use 0.0.33

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0473e74fc7e85e11ce7f5cc7d2fe6242d751ee7
+  data.tar.gz: 6b35bc41d76c3e2ec80a709ed953a65472119b13
+SHA512:
+  metadata.gz: ad0c5b7c90a2cbc7233ac70ecd1c9d8331e2ca598824951e89f718bbe5a4a092454abfe31a330da05faa8a95b58feaf9de1eb8ad3ac0804a2e51b939fb324adf
+  data.tar.gz: 82a7d6abfed777c5a5b9f33bb484456ca39f53cdb5160d76c9c9f443c0ddcd245e6bf8aa22c33893dcd0151bf2e0d9682d094a6cf3e0ddb3be203b3d7b74989c

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails2use.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Manuel Dudda
+
+MIT License
+
+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,49 @@
+# Rails2use
+
+Extracts all rails model to one UML file written in USE (UML-based Specification Environment).
+
+Currently is only ActiveRecord supported. Wrappers for Mongoid and others are planned.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails2use'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails2use
+
+## Usage
+
+Running Rake-Task:
+
+    rake doc:uml FORMAT=use|plantuml TYPE=object,class
+    
+Options:
+
+- FORMAT: use | plantuml (default = plantuml)
+- TYPE: object | class (default = object,class)
+- OUTPUT: *filename* (default = doc/output.puml)
+
+You can use multiple options in a comma separated way
+
+Using in Ruby:
+
+    require 'Rails2use'
+
+    Rails2use.extract! # default will extract the use file to rails_project/doc/gen/uml/output.use
+
+    Rails2use.extract! file: Rails.root.join('doc', 'gen', 'api', 'uml', 'apiv2.use') # the folder structure will be automtically generated
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rails2use/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/rails2use/plantuml_writer.rb

@@ -0,0 +1,94 @@
+class PlantumlWriter
+  def self.suffix
+    'puml'
+  end
+
+  attr_accessor :types, :file
+
+  def initialize(file_name)
+    @filename = file_name
+    @object_filename = file_name.to_s.gsub(/\..*\/?$/, '_instances.puml')
+    @associations = ""
+    @types = {
+        'integer' => 'Integer',
+        'double' => 'Real',
+        'float' => 'Real',
+        'boolean' => 'Boolean',
+        'string' => 'String'
+    }
+  end
+
+  def close
+    @file.try :close
+    @instances_file.try :close
+  end
+
+  def write_head(type=:class)
+    file = case type
+             when :object then
+               @instances_file = File.open(@object_filename, 'w')
+               @instances_file
+             else
+               @file = File.open(@filename, 'w')
+               @file
+           end
+    file.write "@startuml\n\n" #write head
+  end
+
+  def write_foot(type=:class)
+    file = case type
+             when :object then
+               @instances_file
+             else
+               @file
+           end
+    file.write "\n@enduml"
+  end
+
+  def write_abstract_class(class_name)
+    @file.write "abstract class #{class_name}\n"
+  end
+
+  def write_class(class_name, super_classes="", attributes="", associations={})
+    @file.write "#{super_classes} <|- #{class_name}\n" unless super_classes.blank?
+    @file.write "class #{class_name} {\n#{attributes}\n}\n\n"
+
+    associations[:has_many].each do |name, values|
+      @associations << values[:class_name]+ ' "1" o-- "*" '+ values[:foreign_class_name] + "\n"
+
+      #@associations << "association #{name} between\n"
+      #@associations << "\t#{values[:class_name]}[1] role #{values[:role_name]}\n"
+      #@associations << "\t#{values[:foreign_class_name]}[*] role #{values[:foreign_role_name]}\nend\n\n"
+    end
+
+
+    associations[:has_one].each do |name, values|
+      @associations << values[:class_name]+ ' "1" o-- "1" '+ values[:foreign_class_name] + "\n"
+    end
+  end
+
+  def write_class_end
+    @file.write @associations
+  end
+
+  def write_instance(instance_name, class_name, attributes=[], associations={})
+    @instances_file.write "object #{instance_name}{\n"
+    attributes.each do |attribute, value|
+      if value.is_a?(Numeric) || value.is_a?(TrueClass) || value.is_a?(FalseClass)
+        @instances_file.write "#{attribute} = #{value}\n"
+      else
+        @instances_file.write "#{attribute} = '#{value}'\n"
+      end
+    end
+    @instances_file.write "}\n\n"
+    associations.each do |x|
+
+    end
+
+  end
+
+  def write_association(association_name, instance_name, foreign_instance_name)
+    @instances_file.write "#{instance_name} o-- #{foreign_instance_name}\n"
+  end
+
+end

data/lib/rails2use/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails2use'
+require 'rails'
+module Rails2use
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      f = File.join(File.dirname(__FILE__), '..', '..', 'tasks', 'uml.rake')
+      load f
+      # load 'tasks/uml.rake'
+    end
+  end
+end

data/lib/rails2use/use_writer.rb

@@ -0,0 +1,85 @@
+class UseWriter
+  def self.suffix
+    'use'
+  end
+
+  attr_accessor :types, :file
+
+  def initialize(file_name)
+    @filename = file_name
+    @associations = ""
+    @object_filename = file_name.to_s.gsub(/\..*\/?$/, '_instances.use_cmd')
+    @types = {
+        'integer' => 'Integer',
+        'double' => 'Real',
+        'float' => 'Real',
+        'boolean' => 'Boolean',
+        'string' => 'String'
+    }
+  end
+
+  def close
+    @file.try :close
+    @instances_file.try :close
+  end
+
+  def write_head(type=:class)
+    case type
+      when :object then
+        @instances_file = File.open(@object_filename, 'w')
+      else
+        @file = File.open(@filename, 'w')
+        @file.write "model #{Rails.application.class.parent_name}\n\n-- classes\n\n" #write head
+    end
+
+  end
+
+  def write_foot(type=:class)
+
+  end
+
+  def write_abstract_class(class_name)
+    @file.write "abstract class #{class_name}\n\nend\n\n"
+  end
+
+  def write_class(class_name, super_classes="", attributes="", associations={})
+    super_classes = " < #{super_classes}" unless super_classes.blank?
+    @file.write "class #{class_name}#{super_classes}\nattributes\n#{attributes}\nend\n\n"
+
+    associations[:has_many].each do |name, values|
+      @associations << "association #{name} between\n"
+      @associations << "\t#{values[:class_name]}[1] role #{values[:role_name]}\n"
+      @associations << "\t#{values[:foreign_class_name]}[*] role #{values[:foreign_role_name]}\nend\n\n"
+    end
+
+
+    associations[:has_one].each do |name, values|
+      @associations << "association #{name} between\n"
+      @associations << "\t#{values[:class_name]}[1] role #{values[:role_name]}\n"
+      @associations << "\t#{values[:foreign_class_name]}[1] role #{values[:foreign_role_name]}\nend\n\n"
+    end
+  end
+
+  def write_class_end
+    @file.write @associations
+  end
+
+  def write_instance(instance_name, class_name, attributes=[], associations={})
+    @instances_file.write "!create #{instance_name}:#{class_name}\n"
+    attributes.each do |attribute, value|
+      if value.is_a?(Numeric) || value.is_a?(TrueClass) || value.is_a?(FalseClass)
+        @instances_file.write "!set #{instance_name}.#{attribute} := #{value.to_s}\n"
+      else
+        @instances_file.write "!set #{instance_name}.#{attribute} := '#{value.to_s}'\n"
+      end
+    end
+    associations.each do |x|
+
+    end
+  end
+
+  def write_association(association_name, instance_name, foreign_instance_name)
+    @instances_file.write "!insert (#{instance_name}, #{foreign_instance_name}) into #{association_name}\n"
+  end
+
+end

data/lib/rails2use/version.rb

@@ -0,0 +1,3 @@
+module Rails2use
+  VERSION = '0.0.33'
+end

data/lib/rails2use.rb

@@ -0,0 +1,131 @@
+%w(version use_writer plantuml_writer railtie).each { |f| require "rails2use/#{f}" }
+
+module Rails2use
+  attr_accessor :writer
+
+  def self.extract!(options={})
+    Rails2use.extract(options)
+  end
+
+  def self.extract(options={})
+    options[:writer] ||= 'PlantumlWriter'
+    const_writer = options[:writer].constantize
+    suffix = const_writer.suffix
+    options[:file] ||= Rails.root.join('doc', 'uml', "output.#{suffix}")
+
+    types = if options[:type]
+              options[:type].split(',').map { |t| t.strip.downcase }
+            else
+              'class'
+            end
+
+    path = Rails.root.join ''
+    sub_paths = (options[:file].to_s+'/').gsub(path.to_s, '').split('/')
+
+    sub_paths.each do |subdir|
+      path = path.join subdir
+      Dir.mkdir(path.dirname) unless Dir.exists?(path.dirname)
+    end
+    #path
+
+    abstract_classes = []
+    subclasses = {}
+
+    model_blacklist = defined?(Doorkeeper) ? [Doorkeeper::AccessGrant, Doorkeeper::AccessToken, Doorkeeper::Application] : []
+    Rails.application.eager_load! #unless Rails.configuration.cache_classes
+    all_models = (ActiveRecord::Base.descendants - model_blacklist)
+
+    attribute_blacklist = %w(model)
+
+    @writer = const_writer.new options[:file]
+
+    @writer.write_head :class if types.include?('class')
+    #abstract classes first
+    all_models.each do |model|
+
+      #belongs_to
+      model.reflect_on_all_associations(:belongs_to).each do |association|
+        #extract polymorphic classes and determine abstract class status
+        class_name = association.name.to_s.camelcase
+        if association.options.has_key?(:polymorphic)
+          if !abstract_classes.include?(class_name)
+            @writer.write_abstract_class class_name if types.include?('class')
+            abstract_classes << class_name
+          end
+          subclasses[model.name] = [class_name]
+        end
+      end
+    end
+
+    all_models.each do |model|
+      model_associations = {:has_many => {}, :has_one => {}}
+      #def_abstract_class = abstract_classes.include?(model.name) ? 'abstract ' : ''
+      def_super_classes = subclasses.has_key?(model.name) ? subclasses[model.name].join(',') : ''
+
+      model_attributes = ''
+      attribute_names = model.try(:attribute_names) rescue model.columns.map { |c| c.name }
+      attribute_names.each do |attribute|
+        model_attributes << " #{attribute} : #{@writer.types[model.columns_hash[attribute].type.to_s]}\n" if @writer.types.has_key?(model.columns_hash[attribute].type.to_s) && !attribute_blacklist.include?(attribute)
+      end
+
+      #has_many
+      model.reflect_on_all_associations(:has_many).each do |association|
+        #extract associations, also belongs_to are covered by this feature
+        class_name = association.options.has_key?(:as) && abstract_classes.include?(association.options[:as].to_s.camelcase) ? association.options[:as].to_s.camelcase : association.class_name
+        model_associations[:has_many][(model.name.to_s+'_'+association.name.to_s).camelcase] = {class_name: model.name, role_name: (association.name.to_s+model.name).underscore, foreign_class_name: class_name, foreign_role_name: association.name}
+      end
+
+      #has_and_belongs_to_many
+
+      #has_one
+      model.reflect_on_all_associations(:has_one).each do |association|
+        #skip thorugh-associations
+        unless association.options.has_key?(:through)
+          model_associations[:has_one][(model.name.to_s+'_'+association.name.to_s).camelcase] = {class_name: model.name, role_name: (association.name.to_s+model.name).underscore, foreign_class_name: association.class_name, foreign_role_name: association.name}
+        end
+      end
+      @writer.write_class model.name, def_super_classes, model_attributes, model_associations if types.include?('class')
+    end
+    @writer.write_class_end if types.include?('class')
+
+    @writer.write_foot :class if types.include?('class')
+    # end class diagram
+
+    if types.include?('object')
+      @writer.write_head :object
+      all_instances = []
+      all_models.each do |model|
+        all_instances_by_model = model.unscoped.all
+        all_instances += all_instances_by_model
+        all_instances_by_model.each do |instance|
+          instance_name = "#{model.name.underscore}#{instance.id.to_s}"
+          attributes = {}
+          attribute_names = model.try(:attribute_names) rescue model.columns.map { |c| c.name }
+          attribute_names.each do |attribute|
+            if @writer.types.has_key?(model.columns_hash[attribute].type.to_s) && !attribute_blacklist.include?(attribute)
+              value = instance.send attribute
+              attributes[attribute] = value if value.present?
+            end
+          end
+          @writer.write_instance instance_name, model.name, attributes
+        end
+      end
+      all_instances.each do |instance|
+        model = instance.class
+        instance_name = "#{model.name.underscore}#{instance.id.to_s}"
+        model.reflect_on_all_associations(:has_many).each do |association|
+          association_name = (model.name.to_s+'_'+association.name.to_s).camelcase
+          foreign_instances = instance.send association.name
+          foreign_instances = [foreign_instances] unless foreign_instances.is_a?(Enumerable)
+          foreign_instances.each do |foreign_instance|
+            @writer.write_association association_name, instance_name, foreign_instance.class.to_s.underscore+foreign_instance.id.to_s
+          end
+          #class_name = association.options.has_key?(:as) && association.options[:as].to_s.camelcase.in?(abstract_classes) ? association.options[:as].to_s.camelcase : association.class_name
+        end
+      end
+      @writer.write_foot :object
+    end
+    @writer.close
+    options[:file]
+  end
+end

data/rails2use.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails2use/version'
+
+Gem::Specification.new do |spec|
+  spec.name = "rails2use"
+  spec.version = Rails2use::VERSION
+  spec.authors = ["Manuel Dudda"]
+  spec.email = ["dudda@redpeppix.de"]
+  spec.summary = "Extracts all rails model to one UML file written in USE (UML-based Specification Environment)."
+  spec.description = "Currently only ActiveRecord is supported. Wrappers for Mongoid and others are planned."
+  spec.homepage = ""
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency 'rake', '~> 0'
+  spec.add_development_dependency 'rspec', '~> 0'
+  spec.homepage= 'https://github.com/manuel84/rails2use'
+
+  spec.add_runtime_dependency 'rails'#, '~> 0'
+end

data/spec/lib/rails2use_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Rails2use do
+  it "dummy" do
+    true.should be_true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rails2use'

data/tasks/uml.rake

@@ -0,0 +1,25 @@
+namespace :doc do
+
+  desc 'Generates UML diagrams.'
+  task :uml => :environment do
+    puts 'Generating ...'
+    options = {}
+    options[:file] = ENV['OUTPUT'] if ENV['OUTPUT']
+    options[:writer] = case ENV['FORMAT']
+                         when /plant(_)?(uml)?/
+                           'PlantumlWriter'
+                         when /use(_)?(uml)?/
+                           'UseWriter'
+                         else
+                           'PlantumlWriter'
+                       end
+
+    options[:type] = ENV['TYPE'] ? ENV['TYPE'] : 'class'
+
+    file = Rails2use.extract! options
+    puts "using #{options[:writer]}"
+    puts "uml diagrams: #{options[:type]}"
+    puts "output written to #{File.split(file)[0]}."
+  end
+
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rails2use
+version: !ruby/object:Gem::Version
+  version: 0.0.33
+platform: ruby
+authors:
+- Manuel Dudda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Currently only ActiveRecord is supported. Wrappers for Mongoid and others
+  are planned.
+email:
+- dudda@redpeppix.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails2use.rb
+- lib/rails2use/plantuml_writer.rb
+- lib/rails2use/railtie.rb
+- lib/rails2use/use_writer.rb
+- lib/rails2use/version.rb
+- rails2use.gemspec
+- spec/lib/rails2use_spec.rb
+- spec/spec_helper.rb
+- tasks/uml.rake
+homepage: https://github.com/manuel84/rails2use
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Extracts all rails model to one UML file written in USE (UML-based Specification
+  Environment).
+test_files:
+- spec/lib/rails2use_spec.rb
+- spec/spec_helper.rb