asposeslides 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe0567df4a3a8940985484d6884fecc962d45243
+  data.tar.gz: df20b69632d3ef5ac3e1bcc178b94a9256caf00b
+SHA512:
+  metadata.gz: 43af50b1b93e29141fb9044f84bef344a0af5277ed0518483f04345b299577a0516fb4a80ce4eb961c2a898cbabbc1a42871d6122a1d300555f913f436fef148
+  data.tar.gz: c36ebad06841035a61b7a82f81fc43a75336a0fb6efb2f871c248d6b7f92d0e8cd2b9dce2bd19799b229fb866d95c04c02f3306df85325ef4818c755e44a3501

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/
+.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sanjeev Mishra
+
+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,75 @@
+# Asposeslides
+
+Aspose slides is a gem that helps you use the aspose slides for JAVA (http://docs.aspose.com:8082/docs/display/slidesjava/Product+Overview) library from within your ruby/rails project. This library has been tested with aspose.slides-14.9.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'asposeslides'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install asposeslides
+
+## Usage : Rails app
+
+* Create a file aspose.yml under app/config folder. This file specifies the path to your aspose slides for Java path. Put the following lines in that file:
+```yaml
+development:
+  jar_dir: /path/to/your/asposeslides/jars/directory
+test:
+  jar_dir: /path/to/your/asposeslides/jars/directory
+```
+* Next you need to initialize the aspose library. Aspose is a paid library and therefor you need to buy the appropriate license and provide the path to the licensed java library to initialize the gem.
+* Create a file called aspose.rb under the initializer app/config/initializers folder. Put the following lines in the file
+```ruby
+Asposeslides.configure_aspose_slides YAML.load(File.read('config/aspose.yml'))[Rails.env]
+```
+* Now is the time to include the required files for working with the powerpoint presentations. Following is an example of merging 2 presentations into one:
+```ruby
+require 'asposeslides'
+include Asposeslides
+include Asposeslides::Powerpoint
+initialize_aspose
+dest_ppt = File.join('dest_template.pptx')
+src_ppt1 = File.join('src_template1.pptx')
+src_ppt2 = File.join('src_template2.pptx')
+merged_ppt = merge_ppts(dest_ppt, [{:ppt => src_ppt1, :position => 2, :replace => true}, {:ppt => src_ppt2, :position => 5, :replace => true}])
+merged_ppt.save("merged.pptx",3)
+```
+
+Lets understand the above code
+1. The first line makes sure that the aspose slides is loaded and available
+2. Include the files that are required to access the aspose slides
+3. Initialize the libraries. The aspose JAVA classes are loaded from the path provided in the aspose.yml file
+4. Next we have to start with initializing files that need to be merged. In this example, the dest_ppt, src_ppt1, src_ppt2 needs to be merged.
+5. The merge_ppts method, takes the dest_ppt and the src_ppts (1 and 2) and merge them together to generate a new ppt file. The src ppts can be provided with various options.
+
+##### Options for merge_ppts
+* dest_ppt : this is the ppt in which you want merge other ppts
+* The second option is an array of src_ppt hashes. The hash is as follows
+```ruby
+{:ppt => src_ppt1, :position => 2, :replace => true}
+```
+* :ppt parameter represents the ppt that needs to be merged with dest_ppt.
+* :position parameter represents the index of the dest_ppt at which the slides form src_ppt needs to be inserted
+* :replace parameter (default false) indicates if you want to replace the slide in dest_ppt at the given position or not.
+
+## TODO
+* Make it work with the http urls of ppts
+* Extend the gem for other slide operations like add, delete, reorder etc
+
+## Contributing
+
+1. Fork it ( https://github.com/sanjusoftware/asposeslides/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,2 @@
+require "bundler/gem_tasks"
+

data/asposeslides.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'asposeslides/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'asposeslides'
+  spec.version       = Asposeslides::VERSION
+  spec.authors       = ['Sanjeev Mishra']
+  spec.email         = ['sanjusoftware@gmail.com']
+  spec.summary       = %q{A Ruby gem to work with aspose libraries}
+  spec.description   = %q{asposeslides is a Ruby gem that can help working with aspose libraries}
+  spec.homepage      = 'https://github.com/sanjusoftware/asposeslides'
+  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.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_dependency 'rjb', '1.5.2'
+
+end

data/config/aspose.yml

@@ -0,0 +1 @@
+jar_dir: ../asposeslides/jars

data/lib/asposeslides/powerpoint.rb

@@ -0,0 +1,40 @@
+module Asposeslides
+  module Powerpoint
+
+    def create_ppt(file = nil)
+      file ? Rjb::import('com.aspose.slides.Presentation').new(file) : Rjb::import('com.aspose.slides.Presentation').new
+    end
+
+    def get_notes(ppt, index)
+      slide = ppt.getSlides().get_Item(index)
+      slide.getNotesSlide() ? slide.getNotesSlide().getNotesTextFrame().getText() : ''
+    end
+
+    def merge_ppts(dest_ppt, src_ppt_options)
+      destPres = create_ppt(dest_ppt)
+      offset_position = 0
+
+      src_ppt_options.each do |ppt_option|
+        src_ppt = ppt_option[:ppt]
+        position = ppt_option[:position]
+        replace = ppt_option[:replace]
+
+        srcPres = create_ppt(src_ppt)
+        dest_slides = destPres.getSlides()
+        src_slides = srcPres.getSlides()
+
+        if position
+          dest_slides.remove(dest_slides.get_Item(position + offset_position)) if replace
+          (0..src_slides.toArray().length-1).map{|i| dest_slides.insertClone(position + offset_position + i, src_slides.get_Item(i))}
+
+          offset_position = offset_position + (replace ? (src_slides.toArray().length - 1) : (src_slides.toArray().length))
+
+        else
+          (0..src_slides.toArray().length-1).map{|i| dest_slides.addClone(src_slides.get_Item(i))}
+        end
+      end
+      destPres
+    end
+
+  end
+end

data/lib/asposeslides/version.rb

@@ -0,0 +1,3 @@
+module Asposeslides
+  VERSION = '0.0.1'
+end

data/lib/asposeslides.rb

@@ -0,0 +1,30 @@
+require 'asposeslides/version'
+require 'asposeslides/powerpoint'
+require 'logger'
+require 'rjb'
+
+module Asposeslides
+
+  class << self
+    attr_accessor :aspose_slides_config
+  end
+
+  def initialize_aspose
+    dir = Asposeslides.aspose_slides_config ? Asposeslides.aspose_slides_config['jar_dir'] : nil
+
+    if dir && File.exist?(dir)
+      jardir = File.join(dir, '**', '*.jar')
+    else
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::WARN
+      logger.warn('Using the non licensed aspose slides jar. Please specify path to your licensed aspose slides jar directory in config/aspose.yml file!')
+      jardir = File.join(File.dirname(File.dirname(__FILE__)),'jars', '**', '*.jar')
+    end
+    Rjb::load(classpath = Dir.glob(jardir).join(':'), jvmargs=['-Djava.awt.headless=true'])
+  end
+
+
+  def self.configure_aspose_slides config
+    Asposeslides.aspose_slides_config = config
+  end
+end

data/spec/asposeslides_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'Asposeslides Initialization' do
+
+  include Asposeslides
+
+  it 'should initialize aspose and return a valid object' do
+    initialize_aspose
+    expect(Rjb::import('com.aspose.slides.Presentation').new).not_to be_nil
+  end
+
+end

data/spec/powerpoint_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+require 'asposeslides/powerpoint'
+
+describe 'Asposeslides::Powerpoint' do
+
+  include Asposeslides
+  include Asposeslides::Powerpoint
+
+  context 'powerpoint' do
+
+    before do
+      initialize_aspose
+    end
+
+    context 'create' do
+      it 'should create a new presentation for a given file' do
+        file = File.join(File.dirname(File.dirname(__FILE__)), 'spec', 'data', 'dest_template.pptx')
+        ppt = create_ppt(file)
+        expect(ppt).to_not be_nil
+      end
+    end
+
+    context 'notes' do
+      it 'should give the notes for a given slide in a ppt' do
+        ppt_file = File.join(File.dirname(File.dirname(__FILE__)), 'spec', 'data', 'dest_template.pptx')
+        ppt = create_ppt(ppt_file)
+        expect(get_notes(ppt, 2)).to eq('NOTE1')
+      end
+    end
+
+    context 'merge' do
+      it 'should append given source presentation into destination presentation' do
+        dest_ppt = File.join(File.dirname(File.dirname(__FILE__)), 'spec', 'data', 'dest_template.pptx')
+        src_ppt = File.join(File.dirname(File.dirname(__FILE__)), 'spec', 'data', 'src_template1.pptx')
+
+        ppt1 = create_ppt(dest_ppt)
+        ppt2 = create_ppt(src_ppt)
+
+        merged_ppt = merge_ppts(dest_ppt, [{:ppt => src_ppt}])
+        expect(merged_ppt.getSlides().toArray().length).to eq(ppt1.getSlides().toArray().length + ppt2.getSlides().toArray().length)
+      end
+
+      it 'should insert slides from source presentation into destination presentation at a given position' do
+        dest_ppt = File.join(File.dirname(File.dirname(__FILE__)), 'spec', 'data', 'dest_template.pptx')
+        src_ppt = File.join(File.dirname(File.dirname(__FILE__)), 'spec', 'data', 'src_template1.pptx')
+
+        ppt1 = create_ppt(dest_ppt)
+        ppt2 = create_ppt(src_ppt)
+
+        merged_ppt = merge_ppts(dest_ppt, [{:ppt => src_ppt, :position => 4}])
+        expect(merged_ppt.getSlides().toArray().length).to eq(ppt1.getSlides().toArray().length + ppt2.getSlides().toArray().length)
+      end
+
+      it 'should replace a slide at a given position in destination presentation with slides from source presentation' do
+        dest_ppt = File.join(File.dirname(File.dirname(__FILE__)), 'spec', 'data', 'dest_template.pptx')
+        src_ppt = File.join(File.dirname(File.dirname(__FILE__)), 'spec', 'data', 'src_template1.pptx')
+
+        ppt1 = create_ppt(dest_ppt)
+        ppt2 = create_ppt(src_ppt)
+
+        merged_ppt = merge_ppts(dest_ppt, [{:ppt => src_ppt, :position => 4, :replace => true}])
+        expect(merged_ppt.getSlides().toArray().length).to eq((ppt1.getSlides().toArray().length + ppt2.getSlides().toArray().length) - 1)
+      end
+
+      it 'should replace multiple slides at a given positions in destination presentation with slides from multiple source presentations' do
+        dest_ppt = File.join(File.dirname(File.dirname(__FILE__)), 'spec', 'data', 'dest_template.pptx')
+        src_ppt1 = File.join(File.dirname(File.dirname(__FILE__)), 'spec', 'data', 'src_template1.pptx')
+        src_ppt2 = File.join(File.dirname(File.dirname(__FILE__)), 'spec', 'data', 'src_template2.pptx')
+
+        ppt1 = create_ppt(dest_ppt)
+        ppt2 = create_ppt(src_ppt1)
+        ppt3 = create_ppt(src_ppt2)
+
+        merged_ppt = merge_ppts(dest_ppt, [{:ppt => src_ppt1, :position => 2, :replace => true}, {:ppt => src_ppt2, :position => 5, :replace => true}])
+        expect(merged_ppt.getSlides().toArray().length).to eq((ppt1.getSlides().toArray().length + ppt2.getSlides().toArray().length + ppt3.getSlides().toArray().length) - 2)
+
+        merged_ppt = merge_ppts(dest_ppt, [{:ppt => src_ppt1, :position => 2}, {:ppt => src_ppt2, :position => 5}])
+        expect(merged_ppt.getSlides().toArray().length).to eq((ppt1.getSlides().toArray().length + ppt2.getSlides().toArray().length + ppt3.getSlides().toArray().length))
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+require 'yaml'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'Asposeslides'
+
+Asposeslides.configure_aspose_slides YAML.load(File.read('config/aspose.yml'))

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: asposeslides
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sanjeev Mishra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: rjb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+description: asposeslides is a Ruby gem that can help working with aspose libraries
+email:
+- sanjusoftware@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- asposeslides.gemspec
+- config/aspose.yml
+- jars/aspose.slides-14.9.0.jar
+- lib/asposeslides.rb
+- lib/asposeslides/powerpoint.rb
+- lib/asposeslides/version.rb
+- spec/asposeslides_spec.rb
+- spec/data/dest_template.pptx
+- spec/data/src_template1.pptx
+- spec/data/src_template2.pptx
+- spec/powerpoint_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sanjusoftware/asposeslides
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A Ruby gem to work with aspose libraries
+test_files:
+- spec/asposeslides_spec.rb
+- spec/data/dest_template.pptx
+- spec/data/src_template1.pptx
+- spec/data/src_template2.pptx
+- spec/powerpoint_spec.rb
+- spec/spec_helper.rb