nd_transcriber 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b38a8fc84b338d68d21a77e46d9701cb45d5fd3d
-  data.tar.gz: 2b2809662477271a5fc709cc62a2b075a270f427
+  metadata.gz: e32b9fb1b31388648d8e4a0fe0dcd8778cc3182e
+  data.tar.gz: 36df75be15a632094efe1fd2d4b02cfe11ffe15c
 SHA512:
-  metadata.gz: d56af65d922c2e2935793eb95a496b15667f51e468bbfa70c693b4148f2886e48924ac69859256acb93b11769ac31ad0c6dee4190c9b9bab6e1c1d87a5991b5b
-  data.tar.gz: fb679153664c21ad718cea94af008d71dca4751837745c7885bd0521416f9c225d51a2a61b0cd46b2b6642e483fda14cbb81d97cc8446e2a807d0e01938746cf
+  metadata.gz: a00aa9c9594a3ee44e44fd56e18cba47eb5e983fcaa1f2d3a75e1c45496b75f544eb1d11af97e16edf28bc8feb1024ad34f8912845017a18de8e9c93de80e917
+  data.tar.gz: 102e8f7119ea4be32d1be08ba234e673b05d32b5952d35e8d183567771cce9da10e681aaeea42dc0349abc6cd46cf1db54e42e82263c5e1d2a66a25ed2a64e11

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -0,0 +1,65 @@
+# Transcriber
+
+This gem provides an easy way to copy attributes around.
+
+## Installation
+
+```bash
+gem install nd_transcriber
+```
+
+Using bundler:
+
+```ruby
+gem 'nd_transcriber'
+```
+
+## Usage
+
+Basically, you just need to include `NdTranscriber` and define a block wich will
+be called every time an object is copied.
+
+```ruby
+# We are going to copy from Origin objects.
+Origin = Struct.new(:name, :last_name, :gender)
+
+# Dest objects will receive the copied values
+Dest = Struct.new(:name, :last_name, :complete_name, :male_female, :transcribed,
+  :nickname) do
+  include NdTranscriber
+
+  transcriber do
+    copy_fields :last_name,       # Copies field last_name as is
+      :gender => :male_female,    # Copies field gender to field male_female
+      :name => [:name, :nickname] # Copies field name to both name and nickname
+
+    copy :name, to: :complete_name do |name| # Uses the value returned from the block
+      # origin is a method that returns the object we are currently copying data from
+      "#{name} #{origin.last_name}"
+    end
+
+    # You can also just assign attributes to self.
+    self.transcribed = true
+  end
+end
+
+origin = Origin.new('John', 'Doe', 'M')
+
+# The kind of object being copied doesn't matter. It just needs to have the
+# attributes or methods NdTranscriber was told to copy from.
+dest   = Dest.transcribe(origin)
+
+dest.name          # => 'John'
+dest.nickname      # => 'John'
+dest.last_name     # => 'Doe'
+dest.complete_name # => 'John Doe'
+dest.male_female   # => 'M'
+dest.transcribed   # => true
+```
+
+## Why?
+
+I need (more than I'd like) to sync data between databases. Initially, I created
+just a class to do so. I just needed to copy attributes from one object to another,
+customizing some values eventually. Now, I'm making it available as a Gem, so
+others can benefit from it and I can share it across projects easily.

data/lib/nd_transcriber/copier.rb

@@ -0,0 +1,38 @@
+module NdTranscriber
+  class Copier
+    attr_accessor :origin, :dest
+
+    def initialize origin, dest
+      self.origin, self.dest = origin, dest
+    end
+
+    def copy_fields *fields
+      fields.each do |field|
+        if field.is_a?(Hash)
+          field.each_pair do |from, to|
+            copy from, to: to
+          end
+        else
+          copy field
+        end
+      end
+      dest
+    end
+
+    def copy field, to: field
+      value = (field && origin.respond_to?(field) ? origin.send(field) : nil )
+      value = yield(value) if block_given?
+      if to.is_a?(Array)
+        to.each do |f|
+          dest.send("#{f}=", value)
+        end
+      else
+        dest.send("#{to}=", value)
+      end
+    end
+
+    def method_missing method, *args, &block
+      dest.send(method, *args, &block)
+    end
+  end
+end

data/nd_transcriber.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name        = 'nd_transcriber'
+  s.version     = '0.0.2'
+  s.date        = '2014-09-12'
+  s.summary     = "Copy object's attributes with ease."
+  s.description = "This gem provides an easy way to copy attributes around."
+  s.authors     = ["Diego Aguir Selzlein"]
+  s.email       = 'diegoselzlein@gmail.com'
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.homepage    = 'https://github.com/nerde/nd_transcriber'
+  s.license     = 'MIT'
+end

data/spec/lib/nd_transcriber_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+Origin = Struct.new(:name, :last_name, :gender)
+
+Dest = Struct.new(:name, :last_name, :complete_name, :male_female, :transcribed,
+  :nickname) do
+  include NdTranscriber
+
+  transcriber do
+    copy_fields :last_name,
+      :gender => :male_female,
+      :name => [:name, :nickname]
+    copy :name, to: :complete_name do |name|
+      "#{name} #{origin.last_name}"
+    end
+    self.transcribed = true
+  end
+end
+
+Dest2 = Struct.new(:id) do
+  include NdTranscriber
+  transcribes_to do |origin|
+    new(5) if origin
+  end
+end
+
+describe NdTranscriber do
+  let(:origin) { Origin.new('John', 'Doe', 'M') }
+
+  subject { Dest.transcribe(origin) }
+
+  it "copies attributes" do
+    expect(subject.name)         .to eq 'John'
+    expect(subject.nickname)     .to eq 'John'
+    expect(subject.last_name)    .to eq 'Doe'
+    expect(subject.complete_name).to eq 'John Doe'
+    expect(subject.male_female)  .to eq 'M'
+    expect(subject.transcribed)  .to eq true
+  end
+
+  it "yields the copied object" do
+    expect{ |probe| Dest.transcribe(origin, &probe) }.to yield_with_args(
+      kind_of(Dest))
+  end
+
+  context "transcribes_to is provided" do
+    subject(:dest2) { Dest2.transcribe(origin) }
+
+    it "uses transcribes_to to define where to transcribe" do
+      expect(dest2.id).to eq(5)
+    end
+  end
+
+  describe "copy_all" do
+    let(:list) { [Origin.new('John', 'Doe', 'M'),
+      Origin.new('Mary', 'Doe', 'F')] }
+
+    subject(:dests) { Dest.transcribe_all(list) }
+
+    it 'copies all of the objects' do
+      expect(dests.size    ).to eq 2
+      expect(dests[1].name ).to eq 'Mary'
+      expect(dests[1].class).to eq Dest
+    end
+
+    it "yields each copied object" do
+      expect{ |probe| Dest.transcribe_all(list, &probe) }.to yield_successive_args(
+        kind_of(Dest), kind_of(Dest))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require File.expand_path('../../lib/nd_transcriber', __FILE__)
+
+RSpec.configure do |config|
+  config.order = "random"
+  config.before(:each) { GC.disable }
+  config.after(:each)  { GC.enable }
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nd_transcriber
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Diego Aguir Selzlein
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies: []
 description: This gem provides an easy way to copy attributes around.
 email: diegoselzlein@gmail.com
@@ -16,7 +16,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- README.md
 - lib/nd_transcriber.rb
+- lib/nd_transcriber/copier.rb
+- nd_transcriber.gemspec
+- spec/lib/nd_transcriber_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/nerde/nd_transcriber
 licenses:
 - MIT
@@ -42,3 +48,4 @@ signing_key:
 specification_version: 4
 summary: Copy object's attributes with ease.
 test_files: []
+has_rdoc: