trello-fs 0.0.1

data/spec/trello-fs/attachment_cleaner_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe TrelloFs::AttachmentCleaner do
+  describe '#remove_old_attachments' do
+    let(:repository) { TestRepository.new }
+
+    let(:old_attachment) { File.join(repository.path, 'Attachments/old/old_attachment.jpg') }
+    let(:new_attachment) { File.join(repository.path, 'Attachments/new/new_attachment.jpg') }
+
+    let(:board) do
+      OpenStruct.new(attachments: [
+        OpenStruct.new(
+          name: 'new_attachment.jpg',
+          card: OpenStruct.new(
+            name: 'new',
+            list: OpenStruct.new(name: 'l')
+          )
+        )
+      ])
+    end
+
+    subject { TrelloFs::AttachmentCleaner.new(repository, board) }
+
+    before :each do
+      [new_attachment, old_attachment].each do |attachment|
+        FileUtils.mkpath(File.dirname(attachment))
+        File.open(attachment, 'w') {|f| f.write('a') }
+      end
+      subject.remove_old_attachments
+    end
+
+    it 'should remove the old file' do
+      expect(File.exist?(old_attachment)).to eq false
+    end
+
+    it 'should keep the new file' do
+      expect(File.exist?(new_attachment)).to eq true
+    end
+
+    it 'should remove the old folder' do
+      expect(File.exist?(File.dirname(old_attachment))).to eq false
+    end
+  end
+end

data/spec/trello-fs/board_builder_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe TrelloFs::BoardBuilder do
+  let(:list) do
+    list = OpenStruct.new
+    list.name = 'List Name'
+    card1 = OpenStruct.new
+    card1.name = 'Card 1'
+    list.cards = [card1]
+    list
+  end
+
+  let(:board) do
+    board = OpenStruct.new
+    board.name = 'Board'
+    board.lists = [list]
+    board
+  end
+
+  let(:board_builder) { TrelloFs::BoardBuilder.new(TestRepository.new, board) }
+
+  context '#readme_content' do
+    subject { board_builder.readme_content }
+
+    it { should include '(List_Name/README.md' }
+    it { should include '(List_Name/Card_1.md' }
+  end
+end

data/spec/trello-fs/card_builder_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe TrelloFs::CardBuilder do
+
+  let(:card) do
+    card = OpenStruct.new(name: 'Card Name', desc: 'Card Description',
+                          labels: [], attachments: [])
+
+    3.times do |i|
+      card.labels << OpenStruct.new(name: "Label #{i}")
+    end
+    card
+  end
+
+  let(:list) do
+    list = OpenStruct.new
+    list.name = 'List Name'
+    list
+  end
+
+  let(:board) do
+    board = OpenStruct.new
+    board.name = 'Board'
+    board
+  end
+
+  let(:board_builder) { TrelloFs::BoardBuilder.new(TestRepository.new, board) }
+  let(:list_builder) { TrelloFs::ListBuilder.new(board_builder, list) }
+  let(:card_builder) { TrelloFs::CardBuilder.new(list_builder, card) }
+
+  subject { card_builder }
+
+  describe '#content' do
+    subject { card_builder.content(['Attachments/file.pdf', 'Attachments/picture.png']) }
+
+    it { should include 'Card Name' }
+    it { should include 'Card Description' }
+    it { should include 'Label 1' }
+    it { should include 'Label 2' }
+    it { should include 'List Name' }
+    it { should include '[file.pdf' }
+    it { should include '![picture.png]' }
+  end
+
+  describe '#path' do
+    it 'returns the correct path' do
+      expected_path = File.join(TestRepository.path, 'List_Name/Card_Name.md')
+      expect(subject.path).to eq expected_path
+    end
+  end
+
+  describe '#build' do
+    it 'creates a file with the content' do
+      subject.build
+
+      expect(File).to exist subject.path
+      expect(File.read(subject.path)).to eq subject.content
+    end
+  end
+end

data/spec/trello-fs/label_builder_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe TrelloFs::LabelBuilder do
+
+  let(:board) { OpenStruct.new(name: 'Board Name') }
+  let(:label) do
+    cards = [
+      OpenStruct.new(
+        name: 'Card 1',
+        list: OpenStruct.new(
+          name: 'List Name',
+          board: board
+        )
+      )
+    ]
+    OpenStruct.new name: 'Label Name', cards: cards
+  end
+
+  let(:builder) { TrelloFs::LabelBuilder.new(
+    TrelloFs::LabelsBuilder.new(TestRepository.new, board),
+    label) }
+
+  describe '#path' do
+    subject { builder.path }
+
+    it { should include 'Labels' }
+    it { should include 'Label_Name.md' }
+  end
+
+  describe '#content' do
+    subject { builder.content }
+
+    it { should include 'Label Name' }
+    it { should include 'Card 1' }
+  end
+end

data/spec/trello-fs/list_builder_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe TrelloFs::ListBuilder do
+
+  let(:list) do
+    list = OpenStruct.new
+    list.name = 'List Name'
+    card1, card2 = OpenStruct.new, OpenStruct.new
+    card1.name, card2.name = 'Card 1', 'Card 2'
+    list.cards = [card1, card2]
+    list
+  end
+
+  let(:board) do
+    board = OpenStruct.new
+    board.name = 'Board'
+    board
+  end
+
+  let(:board_builder) { TrelloFs::BoardBuilder.new(TestRepository.new, board) }
+  let(:list_builder) { TrelloFs::ListBuilder.new(board_builder, list) }
+
+  subject { list_builder }
+
+  describe '#readme_content' do
+    subject { list_builder.readme_content }
+
+    it { should include 'List Name' }
+    it { should include '(Card_1.md' }
+    it { should include '(Card_2.md' }
+  end
+end

data/spec/trello-fs/repository_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe TrelloFs::Repository do
+  describe '#initialize' do
+    it 'raises an error if there are wrong arguments' do
+      expect { subject.new({}) }.to raise_error
+    end
+  end
+end

data/spec/trello-fs/string_to_file_name_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe TrelloFs::StringToFileName do
+  subject { TrelloFs::StringToFileName }
+
+  describe '.convert' do
+    it 'is unique for different strings' do
+      expect(subject.convert('one')).not_to eq subject.convert('two')
+    end
+
+    it 'is the same for the same strings' do
+      expect(subject.convert('one')).to eq subject.convert('one')
+    end
+
+    it 'replaces slashes with dashes' do
+      expect(subject.convert('a file/path')).to eq 'a_filepath'
+    end
+  end
+end

data/spec/trello-fs/trello_api_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+describe TrelloFs::TrelloApi do
+
+  let(:trello_api) { TrelloFs::TrelloApi.new(TestRepository.new) }
+
+  before :each do
+    allow(trello_api).to receive(:download_board_json) { response_body }
+  end
+
+  describe '#board' do
+    let(:board) { trello_api.board }
+    it { expect(board.name).to eq 'Board Name' }
+    it { expect(board.desc).to eq 'Board Description' }
+    it { expect(board.organization_name).to eq 'Matus PhD' }
+    it { expect(board.lists.size).to eq 1 }
+    it { expect(board.attachments.size).to eq 1 }
+
+    let(:list) { board.lists.first }
+    it { expect(list.name).to eq 'List Name' }
+    it { expect(list.cards.size).to eq 1 }
+
+    let(:card) { list.cards.first }
+    it { expect(card.name).to eq 'Card Name' }
+    it { expect(card.desc).to eq 'Card Description' }
+    it { expect(card.checklists.size).to eq 1 }
+
+    let(:checklist) { card.checklists.first }
+    it { expect(checklist.name).to eq 'Checklist' }
+    it { expect(checklist.items.size).to eq 1 }
+
+    let(:checklist_item) { checklist.items.first }
+    it { expect(checklist_item.name).to eq 'Checklist Item 1' }
+    it { expect(checklist_item.state).to eq 'incomplete' }
+  end
+
+  def response_body
+    {
+      "id" => "2174981360244",
+      "name" => "Board Name",
+      "desc" => "Board Description",
+      "descData" => nil,
+      "closed" => false,
+      "idOrganization" => nil,
+      "pinned" => false,
+      "url" => "https://trello.com/b/Wccvd/board",
+      "shortUrl" => "https://trello.com/b/Wccvd",
+      "organization" => {
+        "id" => "264631916292bb8",
+        "name" => "matusphd",
+        "displayName" => "Matus PhD"
+      },
+      "prefs" => {
+      },
+      "labelNames" => {
+        "green" => "", "yellow" => "", "orange" => "", "red" => "", "purple" => "", "blue" => "", "sky" => "", "lime" => "", "pink" => "", "black" => ""
+      },
+      "labels" => [
+        {
+          "id" => "546da5df74d650d56751d2f7",
+          "idBoard" => "546da5dfc9c189f852060244",
+          "name" => "Label 1",
+          "color" => "green",
+          "uses" => 1
+        }
+      ],
+      "cards" => [
+        {
+          "id" => "546da5f05906d2a063bbea85",
+          "checkItemStates" => [],
+          "closed" => false,
+          "dateLastActivity" => "2014-11-20T08:28:18.936Z",
+          "desc" => "Card Description",
+          "descData" => nil,
+          "email" => nil,
+          "idBoard" => "546da5dfc9c189f852060244",
+          "idList" => "546da5e83fa3907212a5eed1",
+          "idMembersVoted" => [],
+          "idShort" => 1,
+          "idAttachmentCover" => nil,
+          "manualCoverAttachment" => false,
+          "idLabels" => [
+            "546da5df74d650d56751d2f7"
+          ],
+          "name" => "Card Name",
+          "labels" => [
+            {
+              "id" => "546da5df74d650d56751d2f7",
+              "idBoard" => "546da5dfc9c189f852060244",
+              "name" => "Label 1",
+              "color" => "green",
+              "uses" => 1
+            }
+          ],
+          "shortUrl" => "https://trello.com/c/il3oSldG",
+          "subscribed" => false,
+          "url" => "https://trello.com/c/il3oSldG/1-20-11-2014",
+          "checklists" => [
+            {
+              "id" => "546da60b9446036c5a6241bd",
+              "name" => "Checklist",
+              "idBoard" => "546da5dfc9c189f852060244",
+              "idCard" => "546da5f05906d2a063bbea85",
+              "pos" => 16384,
+              "checkItems" => [
+                {
+                  "id" => "546da6182183e3d2a1a0e4ab",
+                  "name" => "Checklist Item 1",
+                  "nameData" => nil,
+                  "pos" => 17229,
+                  "state" => "incomplete"
+                }
+              ]
+            }
+          ],
+          "attachments" => [
+            {
+              "bytes" => 262233,
+              "date" => "2015-02-21T17:00:54.423Z",
+              "edgeColor" => nil,
+              "idMember" => "ead2c755d8a670dac6d",
+              "isUpload" => true,
+              "mimeType" => nil,
+              "name" => "main.pdf",
+              "previews" => [],
+              "url" => "https://trello-attachments.s3.amazonaws.com/546da9f852060244/54a85/19/main.pdf",
+              "id" => "70816dbd5085cee"
+            }
+          ]
+        }
+      ],
+      "lists" => [
+        {
+          "id" => "546da5e83fa3907212a5eed1",
+          "name" => "List Name",
+          "closed" => false,
+          "idBoard" => "546da5dfc9c189f852060244",
+          "pos" => 65535,
+          "subscribed" => false
+        }
+      ]
+    }
+  end
+end

data/trello-fs.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trello-fs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trello-fs"
+  spec.version       = TrelloFs::VERSION
+  spec.authors       = ["Matúš Tomlein"]
+  spec.email         = ["matus@tomlein.org"]
+  spec.summary       = %q{A utility for archiving Trello boards into Git repositories.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/matus_tomlein/trello-fs"
+  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"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: trello-fs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matúš Tomlein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-21 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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- matus@tomlein.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- examples/demo_board.rb
+- examples/demo_board/A_List_of_Cards/README.md
+- examples/demo_board/A_List_of_Cards/TrelloFs_Features.md
+- examples/demo_board/A_List_of_Cards/TrelloFs_Installation.md
+- examples/demo_board/A_Second_List_of_Cards/A_card_with_an_image.md
+- examples/demo_board/A_Second_List_of_Cards/README.md
+- examples/demo_board/A_Second_List_of_Cards/This_one_has_a_puppy.md
+- examples/demo_board/Attachments/A_card_with_an_image/cats-cute-cat-animal-cute-grass-photo.jpg
+- examples/demo_board/Attachments/This_one_has_a_puppy/Puppy_2.jpg
+- examples/demo_board/Home
+- examples/demo_board/Labels/cats.md
+- examples/demo_board/Labels/images.md
+- examples/demo_board/Labels/no_name.md
+- examples/demo_board/Labels/puppies.md
+- examples/demo_board/Labels/readme.md
+- examples/demo_board/README.md
+- examples/welcome_board.rb
+- examples/welcome_board/Advanced/Get_the_apps_for_iOS_Android_and_Windows_8.md
+- examples/welcome_board/Advanced/Need_help.md
+- examples/welcome_board/Advanced/README.md
+- examples/welcome_board/Advanced/Use_as_many_boards_as_you_want.md
+- examples/welcome_board/Advanced/Want_tips_usage_examples_or_API_info.md
+- examples/welcome_board/Advanced/Want_to_use_keyboard_shortcuts_We_have_them.md
+- examples/welcome_board/Advanced/Want_updates_on_new_features.md
+- examples/welcome_board/Attachments/You_can_attach_pictures_and_files/taco.png
+- examples/welcome_board/Basics/Click_on_a_card_to_see_whats_behind_it.md
+- examples/welcome_board/Basics/README.md
+- examples/welcome_board/Basics/This_is_a_card.md
+- examples/welcome_board/Basics/Welcome_to_Trello.md
+- examples/welcome_board/Basics/You_can_attach_pictures_and_files.md
+- examples/welcome_board/Basics/any_kind_of_hyperlink_.md
+- examples/welcome_board/Basics/or_checklists.md
+- examples/welcome_board/Home
+- examples/welcome_board/Intermediate/Drag_people_onto_a_card_to_indicate_that_theyre_responsible_for_it.md
+- examples/welcome_board/Intermediate/Finished_with_a_card_Archive_it.md
+- examples/welcome_board/Intermediate/Invite_your_team_to_this_board_using_the_Add_Members_button.md
+- examples/welcome_board/Intermediate/Make_as_many_lists_as_you_need.md
+- examples/welcome_board/Intermediate/README.md
+- examples/welcome_board/Intermediate/Try_dragging_cards_anywhere.md
+- examples/welcome_board/Intermediate/Use_color-coded_labels_for_organization.md
+- examples/welcome_board/Intermediate/You_can_change_the_board_background.md
+- examples/welcome_board/Labels/no_name.md
+- examples/welcome_board/Labels/red_one.md
+- examples/welcome_board/README.md
+- lib/trello-fs.rb
+- lib/trello-fs/attachment_builder.rb
+- lib/trello-fs/attachment_cleaner.rb
+- lib/trello-fs/board_builder.rb
+- lib/trello-fs/builder.rb
+- lib/trello-fs/card_builder.rb
+- lib/trello-fs/label_builder.rb
+- lib/trello-fs/labels_builder.rb
+- lib/trello-fs/list_builder.rb
+- lib/trello-fs/repository.rb
+- lib/trello-fs/repository_cleaner.rb
+- lib/trello-fs/string_to_file_name.rb
+- lib/trello-fs/trello_api.rb
+- lib/trello-fs/version.rb
+- spec/helpers/test_repository.rb
+- spec/spec_helper.rb
+- spec/trello-fs/attachment_builder_spec.rb
+- spec/trello-fs/attachment_cleaner_spec.rb
+- spec/trello-fs/board_builder_spec.rb
+- spec/trello-fs/card_builder_spec.rb
+- spec/trello-fs/label_builder_spec.rb
+- spec/trello-fs/list_builder_spec.rb
+- spec/trello-fs/repository_spec.rb
+- spec/trello-fs/string_to_file_name_spec.rb
+- spec/trello-fs/trello_api_spec.rb
+- trello-fs.gemspec
+homepage: https://github.com/matus_tomlein/trello-fs
+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: A utility for archiving Trello boards into Git repositories.
+test_files:
+- spec/helpers/test_repository.rb
+- spec/spec_helper.rb
+- spec/trello-fs/attachment_builder_spec.rb
+- spec/trello-fs/attachment_cleaner_spec.rb
+- spec/trello-fs/board_builder_spec.rb
+- spec/trello-fs/card_builder_spec.rb
+- spec/trello-fs/label_builder_spec.rb
+- spec/trello-fs/list_builder_spec.rb
+- spec/trello-fs/repository_spec.rb
+- spec/trello-fs/string_to_file_name_spec.rb
+- spec/trello-fs/trello_api_spec.rb