ballmer 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcae2435035fbc72f36f7e7f793b1c952da690da
-  data.tar.gz: 884e3214b7a0b7acb1653a1ce40c7b3c52f3ef84
+  metadata.gz: ee1efee77928b527001187d49afd66daa1b4e171
+  data.tar.gz: 8599a605f1333712b023a80d27f63c34cea2f986
 SHA512:
-  metadata.gz: 62c5311693846c3db3a07146b5df427b5146ebd017f370aab8b5eae98acfcc6bb94b5a8e390cf5f7999f341e28924ec07a43c1a3c5e86196dc73c49266957be2
-  data.tar.gz: 3190b41051a7c694d9574ea83d4d82b1b999a0f95d4e7266ea32a38298a0e81dbb6f699f46be1a69dd883bd53f0f5caf6334c984f9350c70b58b2997c41f2e57
+  metadata.gz: a82783df915fa6271d4339009ec28cc8bb44cd54e16b9356bb4c46e29d3009d7cfc0c0a940c7806f418ef85f16238f8871c2d08b2144a8ed636c698f7c2979cc
+  data.tar.gz: 7bb1ed8fc4e263bb076fe9824cdb78ef695a7ed634879e14cfaa7750da1fe88a40e38774b3c47340de478c972f4070b8dd491e3e61f143ec3ceb8b136ede4d48

data/README.md

@@ -1,18 +1,20 @@
 # Ballmer
 
-[![Build Status](https://travis-ci.org/polleverywhere/ballmer.png?branch=master)](https://travis-ci.org/polleverywhere/ballmer)
+[![Build Status](https://travis-ci.org/polleverywhere/ballmer.png?branch=master)](https://travis-ci.org/polleverywhere/ballmer) [![Code Climate](https://codeclimate.com/repos/52ce169f6956805d89000475/badges/e90c7084bdc02bda6000/gpa.png)](https://codeclimate.com/repos/52ce169f6956805d89000475/feed)
 
 The Ballmer gem provides the basis for modifying Office documents in Ruby. It provides access to low-level primitives including:
 
-* Unzip/zip Office document formats.
-* Low level "part" abstraction and rels resolution.
-* Direct access to manipulating/munging XML.
+* Unzip/zip Office document formats
+* Low level "part" abstraction and "rels" resolution
+* Direct access to manipulating/munging XML
 
-PowerPoint is the only format with a higher-level, but basic abstraction that allows:
+PowerPoint is the only format with a higher-level abstraction that allows:
 
-* Copying and inserting slides.
-* Reading slide notes in the most basic sense. 
-* Writing to slidenotes via a subset of markdown (only paragraphs).
+* Copying and inserting slides
+* Reading slide notes in the most basic sense
+* Writing to slidenotes via a subset of markdown (only paragraphs)
+
+While Word and Excel don't have these abstractions, Ballmer has a "Document" class that can still be used to resolve and manipulate document parts.
 
 ## Installation
 
@@ -30,18 +32,26 @@ Or install it yourself as:
 
 ## Usage
 
+Its highly recommended to get comfortable with [Nokogiri](http://nokogiri.org) and [XPath queries](http://nokogiri.org/tutorials/searching_a_xml_html_document.html). Here's an example of what Ballmer can do:
+
 ```ruby
-# Open a pptx file
-p = Ballmer::Presentation.open("./fixtures/Presentation3.pptx")
-# Copy the first slide into the last position
-p.sides.push p.slides.first
-# Now save the file.
-p.save
+require 'ballmer'
+
+# Open a pptx file.
+prez = Ballmer::Presentation.open Ballmer.path("../spec/fixtures/presentation3.pptx")
+# Copy the first slide into the last position.
+prez.slides.push prez.slides.first
+# Lets manipulate some XML using XPath queries and Nokogiri.
+prez.edit_xml 'docProps/app.xml' do |xml|
+  xml.at_xpath('/xmlns:Properties/xmlns:Company').content = 'Acme Inc.'
+end
+# Now save the file contents.
+# prez.save
 ```
 
 ## Contributing
 
-Microsoft Office is a complicating beast. If you need to grock documents you can help!
+Microsoft Office documents are a complicating beast. I don't intend no support all functionality, but I do think there's a lot of value in higher-level abstractions for various document formats. If you are working on a project and build these abstractions I'd love to merge those with Ballmer.
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/ballmer.rb

@@ -4,4 +4,9 @@ require "nokogiri"
 module Ballmer
   autoload :Presentation, 'ballmer/presentation'
   autoload :Document,     'ballmer/document'
+
+  # Get an absolute path relative to ballmer.
+  def self.path(*args)
+    File.expand_path(File.join('..', args), __FILE__)
+  end
 end

data/lib/ballmer/presentation/slides.rb

@@ -13,9 +13,14 @@ module Ballmer
 
       def each(&block)
         # TODO - Do NOT read content-types, but read Rels instead (and move this type casting in there.)
-        @doc.content_types[Slide::CONTENT_TYPE].each { |path| block.call slide path }
+        slides.each { |path| block.call slide path }
       end
 
+      def size
+        slides.size
+      end
+      alias :length :size
+
       # This method is crazy because it has to manipulate a ton of files within the PPTX. Most of
       # what happens in here I figured out by diff-ing PPTX files that had copies of identical slides, but
       # a different number of slides.
@@ -162,6 +167,10 @@ module Ballmer
         @doc.content_types.parts Slide::CONTENT_TYPE
       end
 
+      def slides
+        @doc.content_types[Slide::CONTENT_TYPE]
+      end
+
       # Microsoft decided it would be cool to start at 1 instead of 0 
       # for the part indices, so this deals with that seperatly
       def next_number

data/lib/ballmer/version.rb

@@ -1,3 +1,3 @@
 module Ballmer
-  VERSION = "0.0.1"
+  VERSION = "1.0.1"
 end

data/spec/lib/ballmer/presentation_spec.rb

@@ -9,6 +9,10 @@ describe Ballmer::Presentation do
     end
   end
 
+  it "should have slides#length" do
+    subject.slides.length.should == 3
+  end
+
   context "slides" do
     let(:original)  { subject.slides.to_a.first }
     let(:copy)      { subject.slides.push original }

data/spec/lib/ballmer_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe Ballmer do
+  describe ".path" do
+    it "should resolve path" do
+      File.should exist(Ballmer.path('../spec/fixtures/presentation3.pptx'))
+    end
+  end
+end

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: ballmer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Brad Gessler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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: guard-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: terminal-notifier-guard
   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: pry
   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: zipruby
   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'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   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: Open and manipulate Office files.
@@ -120,9 +120,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -159,6 +159,7 @@ files:
 - spec/lib/ballmer/presentation/notes_parser_spec.rb
 - spec/lib/ballmer/presentation/tags_spec.rb
 - spec/lib/ballmer/presentation_spec.rb
+- spec/lib/ballmer_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -170,17 +171,17 @@ 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.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Manipulate Office files in Ruby.
@@ -195,4 +196,6 @@ test_files:
 - spec/lib/ballmer/presentation/notes_parser_spec.rb
 - spec/lib/ballmer/presentation/tags_spec.rb
 - spec/lib/ballmer/presentation_spec.rb
+- spec/lib/ballmer_spec.rb
 - spec/spec_helper.rb
+has_rdoc: