sga_fields_synchronizer 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 tim.teng
+
+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.rdoc

@@ -0,0 +1,43 @@
+= sga_fields_synchronizer
+
+Sometimes we have some table fields change frequently, espically for me, we are now building a flash game, there're many characters table, each has many attributes(fields). Game planners 
+frequently change them, they send me a excel file or whatever, I have to diff it with the previous one, get the changes, put them into migration file and finnally apply to database.
+It takes me much time and it's really a born job. So, I coded this migration generator to save my time.
+  
+sga_fields_synchronizer is based on a configure file, which defines the table structure, once you have any modification on the table, just edit the yml file, change the column defination, 
+or just remove the node (if you intend to remove the column) 
+
+== Installation
+
+gem install sga_fields_synchronizer
+
+== Usage
+
+First, run './script/generate fields_synchronizer init' to copy the configure yml into config/ folder
+
+Second, after you editing the yml file properly, just type './script/generate fields_synchronizer sync' to generate migration file
+
+Third, invoke 'rake db:migrate' to apply the chages
+
+You also can generate migrations excluded specified tables with '--skip-table' option, this will automatically excluded tables you specified. By default, sga_fields_synchronizer will skip table "common_fields".
+  
+Once you want to apply DRY principle on your cofigure file, just reference the sample yml file.
+
+== Configure file
+ 
+the root node of the configure file is "configs" by convention, so don't remove that node. the subsequent nodes are tables. Each table field is defined as Array, the first element is the translation
+the second is the field type, such as string, text, integer, etc. The third element is optional, it stands for column options. 
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 tim.teng. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sga_fields_synchronizer"
+    gem.summary = %Q{A synchronizer for most frequently edited columns}
+    gem.description = %Q{ A synchronizer for most frequently edited columns based on yml file}
+    gem.email = "tim.rubist@gmail.com"
+    gem.homepage = "http://github.com/tteng/sga_fields_synchronizer"
+    gem.authors = ["tim.teng"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sga_fields_synchronizer #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/generators/fields_synchronizer/fields_synchronizer_generator.rb

@@ -0,0 +1,123 @@
+require 'fields_reader'
+
+class FieldsSynchronizerGenerator < Rails::Generator::Base
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @action_to_invoke = runtime_args.shift  
+    unless ["init", "sync"].include?(@action_to_invoke)
+      STDOUT.puts 'Invalid arguments!'     
+      STDOUT.puts banner      
+      exit
+    end
+  end
+
+  def manifest
+    recorded_session = record do |m|
+      if(@action_to_invoke == "init")
+        STDOUT.puts ' init ...'
+        unless File.exist? File.join(RAILS_ROOT,'config','fields_dictionary.yml')
+          m.template "fields_dictionary.example", "config/fields_dictionary.yml"
+        else
+         STDOUT.puts "#{RAILS_ROOT}/config/fields_dictionary.yml already exists, override it?(y/n)"
+         if gets.chomp =~ /^y/i
+           m.template "fields_dictionary.example", "config/fields_dictionary.yml"
+         end
+        end
+
+      elsif(@action_to_invoke == "sync")
+
+        FieldsReader.init
+        skipped_tables = (options[:skipped_table] || []) << "common_fields"
+        dictionary = File.join(RAILS_ROOT,'config','fields_dictionary.yml')
+        STDOUT.puts " skip table: #{skipped_tables.join(',')}"
+        STDOUT.puts " dictionary: #{dictionary}"
+
+        (FieldsReader.keys - skipped_tables).each do |t|
+          model = t.singularize.camelize.constantize                     
+          table_columns = get_table_columns model
+          target_columns = FieldsReader.send t
+          removed_columns = get_to_be_deleted_columns(table_columns,target_columns)
+          changed_columns = get_changed_columns(table_columns, target_columns)
+          added_columns = get_added_columns(table_columns, target_columns)
+          unless removed_columns.empty? && changed_columns.empty? && added_columns.empty?
+            m.directory "db/migrate"
+            migration_name = "#{migration_prefix}_change_table_#{t}"
+            m.migration_template 'migration.rb', 'db/migrate',
+                               :assigns => { :migration_name => migration_name.camelize,
+                                 :removed_columns => removed_columns,
+                                 :changed_columns => changed_columns,
+                                 :added_columns => added_columns,
+                                 :table_name => t
+                               },
+                               :migration_file_name => migration_name.camelize 
+          end
+        end
+
+      end
+    end
+  end
+
+  def add_options! opt
+    opt.on('--skip-table tab1, tab2, tab3 ', Array, 'tables skipped to do synchronization') do |v| 
+      options[:skipped_table] = v 
+    end
+  end
+
+  def banner
+    %Q{
+      Usage: #{$0} init 
+      Usage: #{$0} sync [--skip-table t1,[t2 [,t3]]]"
+      Example: #{$0} init
+             #{$0} sync
+             #{$0} sync --skip-table t1, t2, t3
+    }
+  end
+
+  private 
+
+  def get_to_be_deleted_columns tab_cols, tgt_cols
+    tab_cols_dup = tab_cols.dup
+    tab_cols_dup.delete_if{|k,v| tgt_cols.keys.include?(k)}
+    tab_cols_dup
+  end
+
+  def get_table_columns model
+    model.columns.inject({}) do |hash, column|
+      hash[column.name] = column
+      hash
+    end
+  end
+
+  def get_changed_columns tab_cols, tgt_cols
+    (tab_cols.keys & tgt_cols.keys).inject({}) do |hash, col|
+      origin_type = tab_cols[col].type.to_s
+      target_type = tgt_cols[col][1]
+      if origin_type == target_type
+        unless(target_col_options = tgt_cols[col][2]).blank?
+          [:null, :default, :limit, :precision, :scale].each do |k|
+            next unless target_col_options.keys.include?(k)
+            if target_col_options[k] != tab_cols[col].send(k)
+              hash[col] = [tgt_cols[col], tab_cols[col]]
+              break
+            end
+          end 
+        end 
+      else
+        hash[col] = [tgt_cols[col], tab_cols[col]]
+      end
+      hash 
+    end
+  end
+
+  def get_added_columns tab_cols, tgt_cols
+    tgt_dup = tgt_cols.dup
+    tgt_dup.delete_if {|k,v| tab_cols.keys.include?(k)}
+    tgt_dup
+  end
+
+  def migration_prefix
+    "sync_#{Time.now.strftime("%y%b%d%a").underscore}_#{('%0.4f' % rand)[2,4]}"
+  end
+
+end

data/generators/fields_synchronizer/templates/fields_dictionary.example

@@ -0,0 +1,209 @@
+# 公共属性, refers: http://sgftrac/trac/wiki/DataDictionary
+# By TengXianggong, 20100617
+# 数据结构：
+
+# 属性名
+# - 前台显示名称
+# - 数据类型
+# - 字段属性(hash)
+
+
+####################################################
+############   Shared      Fields           ########
+############   Last edited by Tengxianggong ########
+############   Last edited at Jun 17, 2010  ########
+####################################################
+configs:
+
+  common_fields: &common_fields
+    name: 
+      - "名称"
+      - "string"
+    job_id: 
+      - "职业类型"
+      - "integer"
+      - :limit: 10
+        :default: 1
+    level: 
+      - "等级"
+      - "integer"
+      - :default: 1
+    health_point: 
+      - "生命值"
+      - "integer"
+    max_health_point: 
+      - "生命上限"
+      - "integer"
+    magic_point: 
+      - "魔法值"
+      - "integer"
+    max_magic_point:
+      - "魔法上限"
+      - "integer"
+    max_attack_point:
+      - "最大攻击力"
+      - "integer"
+    min_attack_point:
+      - "最小攻击力"
+      - "integer"
+    max_magic_attack_point:
+      - "最大法术攻击力"
+      - "integer"
+    min_magic_attack_point: 
+      - "最小法术攻击力"
+      - "integer"
+    max_defence_point:
+      - "最大防御力" 
+      - "integer"
+    min_defence_point:
+      - "最小防御力" 
+      - "integer"
+    max_magic_defence_point:
+      - "最大法术防御力" 
+      - "integer"
+    min_magic_defence_point:
+      - "最小法术防御力" 
+      - "integer"
+    health_restore_speed: 
+      - "生命恢复"
+      - "integer"
+    magic_restore_speed:
+      - "法力恢复"
+      - "integer"
+    attack_hit_rate: 
+      - "物理命中率"
+      - "integer"
+    magic_hit_rate: 
+      - "魔法命中率"
+      - "integer"
+    attack_dodge_rate: 
+      - "物理闪避率"
+      - "integer"
+    magic_dodge_rate: 
+      - "魔法闪避率"
+      - "integer"
+    power_hit_rate: 
+      - "暴击率"
+      - "integer"
+    power_hit_point: 
+      - "暴击威力"
+      - "integer"
+    explode_point: 
+      - "爆发值"
+      - "integer"
+    luck_point: 
+      - "幸运值"
+      - "integer"
+    defence_rate: 
+      - "伤害减免概率"
+      - "integer"
+    defence_level: 
+      - "伤害减免等级"
+      - "integer"
+    move_speed: 
+      - "行走速度"
+      - "integer"
+    attack_speed: 
+      - "攻击速度"
+      - "integer"
+    fire_attack: 
+      - "火属性伤害"
+      - "integer"
+    thunder_attack:
+      - "雷属性伤害"
+      - "integer"
+    ice_attack: 
+      - "冰属性伤害"
+      - "integer"
+    poison_attack: 
+      - "毒属性伤害"
+      - "integer"
+    fire_defence: 
+      - "火属性防御"
+      - "integer"
+    thunder_defence:
+      - "雷属性防御"
+      - "integer"
+    ice_defence: 
+      - "冰属性防御"
+      - "integer"
+    poison_defence: 
+      - "毒属性防御"
+      - "integer"
+  
+####################################################
+############   PlayerCharacter Fields       ########
+############   Last edited by Tengxianggong ########
+############   Last edited at Jun 17, 2010  ########
+####################################################
+ 
+  player_characters: 
+
+    <<: *common_fields
+
+    gender: 
+      - "性别"
+      - "integer"
+    head_picture: 
+      - "头像"
+      - "integer"
+    hair_style:
+      - "发型"
+      - "integer"
+    hair_color:
+      - "发色"
+      - "integer"
+    exp:
+      - "经验值"
+      - "integer"
+    stage:
+      - "修仙阶段"
+      - "integer"
+    skill_point:
+      - "元神点数"
+      - "integer"
+    fame_point:
+      - "声望值" 
+      - "integer"
+    contribution_point:
+      - "贡献值"
+      - "integer"
+    pk_point:
+      - "PK值"
+      - "integer"
+    family_id:
+      - "归属家族"
+      - "integer"
+    house_id:
+      - "归属门派"
+      - "integer"
+    attack_talisman:
+      - "攻击法宝"
+      - "integer"
+    defence_talisman:
+      - "防御法宝"
+      - "integer"
+    assist_talisman:
+      - "辅助法宝"
+      - "integer"
+    left_finger:
+      - "左手指"
+      - "integer"
+    right_finger:
+      - "右手指"
+      - "integer"
+    shoes:
+      - "鞋子"
+      - "integer"
+    helmet:
+      - "头盔"
+      - "integer"
+    necklace:
+      - "项链"
+      - "integer"
+    clothing:
+      - "衣服"
+      - "integer"
+    cloaks:
+      - "披风"
+      - "integer"

data/generators/fields_synchronizer/templates/migration.rb

@@ -0,0 +1,46 @@
+class <%= migration_name %> < ActiveRecord::Migration
+<%
+  def options_from_table_column col
+    str = [":#{col.type}"] 
+    str << ":default => #{col.default}" unless col.default.nil?
+    str << ":null => false " unless col.null
+    str << ":limit => #{col.limit}" unless col.limit.nil?
+    str << ":precision => #{col.precision}" unless col.precision.nil?
+    str << ":scale => #{col.scale}" unless col.scale.nil?
+    str << ":primary => true" if col.primary
+    str.join(', ')
+  end
+
+  def options_from_target_column hash
+    hash.map{|el| el[0]=":#{el[0]}"; el * " => "} * ", " 
+  end
+%>
+  def self.up
+    <% removed_columns.each_pair do |col, col_info| %>
+      remove_column :<%=table_name%>, :<%=col%>
+    <% end %>
+
+    <% added_columns.each_pair do |col, col_info| %>
+      add_column :<%=table_name%>, :<%=col%>, :<%=col_info[1]%>, <%= options_from_target_column col_info[2] %>
+    <% end %>
+
+    <% changed_columns.each_pair do |col, col_info| %>
+      change_column :<%=table_name%>, :<%=col%>, :<%=col_info[0][1]%>, <%= options_from_target_column col_info[0][2]%>
+    <% end %>
+  end
+  
+  def self.down
+    <% removed_columns.each do |col, col_info| %>
+      add_column :<%=table_name.to_sym%>, :<%= col%>, <%= options_from_table_column col_info%> 
+    <% end %>
+
+    <% added_columns.each_pair do |col, col_info| %>
+      remove_column :<%=table_name%>, :<%=col%>
+    <% end %>
+
+    <% changed_columns.each_pair do |col, col_info| %>
+      change_column :<%=table_name%>, :<%=col%>, <%= options_from_table_column col_info[1]%>
+    <% end %>
+  end
+
+end

data/lib/fields_reader.rb

@@ -0,0 +1,33 @@
+require 'yaml'
+
+class FieldsReader
+
+  YAML_PATH = File.join(RAILS_ROOT, "config", "fields_dictionary.yml")
+
+  class << self
+
+    def init reload=false
+      raise "Missing Config File, Please Check Whether #{YAML_PATH} exists." unless File.exists?(YAML_PATH)
+      if reload 
+        @@config = YAML.load_file(YAML_PATH)["configs"]
+      else
+        @@config ||= YAML.load_file(YAML_PATH)["configs"]
+      end
+    end
+
+    def method_missing mth, *args
+      if mth.to_s =~ /^(.*)=$/ 
+        @@config[$1] = args.first
+      else
+        @@config.respond_to?(mth) ? @@config.send(mth) : @@config[mth.to_s]
+      end
+    end
+
+    def write_back
+      File.open(YAML_PATH,'w'){|f| YAML.dump({"configs" => @@config},f)}
+      init(true)
+    end
+
+  end
+
+end

data/lib/sga_fields_synchronizer.rb

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

data/sga_fields_synchronizer.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{sga_fields_synchronizer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["tim.teng"]
+  s.date = %q{2010-06-23}
+  s.description = %q{ A synchronizer for most frequently edited columns based on yml file}
+  s.email = %q{tim.rubist@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "generators/fields_synchronizer/fields_synchronizer_generator.rb",
+     "generators/fields_synchronizer/templates/fields_dictionary.example",
+     "generators/fields_synchronizer/templates/migration.rb",
+     "lib/fields_reader.rb",
+     "lib/sga_fields_synchronizer.rb",
+     "sga_fields_synchronizer.gemspec",
+     "test/helper.rb",
+     "test/test_sga_fields_synchronizer.rb"
+  ]
+  s.homepage = %q{http://github.com/tteng/sga_fields_synchronizer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A synchronizer for most frequently edited columns}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_sga_fields_synchronizer.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sga_fields_synchronizer'
+
+class Test::Unit::TestCase
+end

data/test/test_sga_fields_synchronizer.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSgaFieldsSynchronizer < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: sga_fields_synchronizer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- tim.teng
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-23 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: " A synchronizer for most frequently edited columns based on yml file"
+email: tim.rubist@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- generators/fields_synchronizer/fields_synchronizer_generator.rb
+- generators/fields_synchronizer/templates/fields_dictionary.example
+- generators/fields_synchronizer/templates/migration.rb
+- lib/fields_reader.rb
+- lib/sga_fields_synchronizer.rb
+- sga_fields_synchronizer.gemspec
+- test/helper.rb
+- test/test_sga_fields_synchronizer.rb
+has_rdoc: true
+homepage: http://github.com/tteng/sga_fields_synchronizer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A synchronizer for most frequently edited columns
+test_files: 
+- test/helper.rb
+- test/test_sga_fields_synchronizer.rb