keynote-client 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c4744a2aa2fb814a90ac556a0713e2eb774c9f2
-  data.tar.gz: 10a2e69dce31aede9cb96c6c340250a7dce40c87
+  metadata.gz: 199382e0930b6b78573c3991566bd4486beef77a
+  data.tar.gz: 8cf1d0be8b19e9725a9e4612c28e90d5dff92260
 SHA512:
-  metadata.gz: 7885c96f7b91d6d5e89ff5d135d05c1745c8a911834eb10843725e7a74925cc947200cfd341fc025aeb3e97e40edc86ff815ee9c10f8a4c12076bdfd8678c938
-  data.tar.gz: b053a819f7e65aced80c6bf0ecac85c4db65606938b258e38ba3f2c947d9389519dd7449d0357cddf7142c26ff0de8fe6ad148ea95eddda925c674c20abf2964
+  metadata.gz: 57f4e0440b614ae1faca604b5e1b0be7ade18cdcfabaabf21cdc0f60295a96bc6ed31f6a299f7ec45bd94ab5e66389a3e7545da97fc7d8de6e2282916a199915
+  data.tar.gz: 06552907f222c935ff961cf44eb2051826b6fe7f0ac993fe10128e3943fc44a627e4170f9aff686e7aff8c7ab681a76d2f30298b73211d6a3eb724156056d97f

data/README.md

@@ -4,16 +4,17 @@
 
 Currently this project is in alpha stage. It supports these features.
 
-- Creating a new document with specified theme
-- Appending a new slide with specified master slide
-- Saving a document
+- Create a new document with specified theme
+- Append a new slide with specified master slide
+- Update slides
+- Save a document
 
 ## Install
 
 Add this line to your application's Gemfile:
 
 ```sh
-gem keynote-client'
+gem 'keynote-client'
 ```
 
 And then execute:
@@ -35,69 +36,31 @@ $ gem install keynote-client
 require 'keynote-client'
 inlude Keynote
 
-themes = Theme.find_by(:all)
-# => [#<Keynote::Theme:0x007fd9ec821748 @id="Application/Black/Standard", @name="ブラック">,
-# #<Keynote::Theme:0x007fd9ec821518 @id="Application/White/Standard", @name="ホワイト">,
-# #<Keynote::Theme:0x007fd9ec820fa0 @id="Application/Gradient/Standard", @name="グラデーション">,
-# #<Keynote::Theme:0x007fd9ec813e40 @id="Application/Parchment/Standard", @name="羊皮紙">,
-# ...
-# #<Keynote::Theme:0x007fd9ec813d78 @id="User/AC506922-367E-4300-AF77-8040B9CFA2B7", @name="cookpad">]
+# Fetch all themes
+themes = Theme.all
 
+# Fetch theme specified name
 theme = Theme.find_by(name: 'ブラック').first
-# #<Keynote::Theme:0x007fd9ec821748 @id="Application/Black/Standard", @name="ブラック">,
 
+# Create a new document with theme
 doc = Document.create(theme: theme, file_path: '/path/to/foo.key')
-# => #<Keynote::Document:0x007fbe03224228
-# @auto_loop=false,
-# @auto_play=false,
-# @auto_restart=false,
-# @current_slide=nil,
-# @document_theme=#<Keynote::Theme:0x007fbe031f6e68 @id="Application/Black/Standard", @name="ブラック">,
-# @height=768,
-# @maximum_idle_duration=15,
-# @name="名称未設定",
-# @slide_numbers_showing=false,
-# @slides=[],
-# @width=1024>
 
+# Save a document at file_path
 doc.save
-# => true
-
-doc.slides
-# => [#<Keynote::Slide:0x007fa17c2bcb98
-#  @base_slide=#<Keynote::MasterSlide:0x007fa17c2bcbe8 @name="タイトル & サブタイトル">,
-#  @body_showing=true,
-#  @default_body_item=nil,
-#  @default_title_item=nil,
-#  @presenter_notes="",
-#  @skipped=false,
-#  @slide_number=1,
-#  @title_showing=true,
-#  @transition_properties={"transitionDelay"=>0.5, "automaticTransition"=>false, "transitionEffect"=>"no transition effect", "transitionDuration"=>1}>]
-
-doc.append_slide("空白")
-# => [#<Keynote::Slide:0x007fa17c2bcb98
-#   @base_slide=#<Keynote::MasterSlide:0x007fa17c2bcbe8 @name="タイトル & サブタイトル">,
-#   @body_showing=true,
-#   @default_body_item=nil,
-#   @default_title_item=nil,
-#   @presenter_notes="",
-#   @skipped=false,
-#   @slide_number=1,
-#   @title_showing=true,
-#   @transition_properties={"transitionDelay"=>0.5, "automaticTransition"=>false, "transitionEffect"=>"no transition effect", "transitionDuration"=>1}>,
-#  #<Keynote::Slide:0x007fa17a8bbc08
-#   @base_slide=#<Keynote::MasterSlide:0x007fa17a8bbc58 @name="空白">,
-#   @body_showing=false,
-#   @default_body_item=nil,
-#   @default_title_item=nil,
-#   @presenter_notes="",
-#   @skipped=false,
-#   @slide_number=2,
-#   @title_showing=false,
-#   @transition_properties={"transitionDelay"=>0.5, "automaticTransition"=>false, "transitionEffect"=>"no transition effect", "transitionDuration"=>1}>]
-```
 
+# Initialize a new slide
+slide = Slide.new("タイトル & 箇条書き", title: 'Pen', body: ["This is a pen", "Is this a pen?"].join("\n"))
+
+# Append slides
+doc.slides << slide
+
+# Fetch last slide
+slide = doc.slides.last
+
+# Update a slide
+slide.title = "About pen"
+slide.body = "Hello, pen."
+```
 
 ## Supported OS
 - OSX Mavericks

data/lib/keynote/document.rb

@@ -1,5 +1,6 @@
 require 'unindent'
 require 'keynote/theme'
+require 'keynote/slide_array'
 require 'keynote/util'
 
 module Keynote
@@ -78,8 +79,8 @@ module Keynote
             skipped: slide.skipped(),
             slide_number: slide.slideNumber(),
             title_showing: slide.titleShowing(),
-            default_body_item: slide.defaultBodyItem(),
-            default_title_item: slide.defaultTitleItem(),
+            body: slide.defaultBodyItem.objectText(),
+            title: slide.defaultTitleItem.objectText(),
             presenter_notes: slide.presenterNotes(),
             transition_properties: slide.transitionProperties()
           })
@@ -87,59 +88,24 @@ module Keynote
         JSON.stringify(results);
       APPLE
 
-      @slides = results.map do |result|
-        Slide.new(
-          base_slide: MasterSlide.new(result["base_slide"]),
-          body_showing: result["body_showing"],
-          skipped: result["skipped"],
-          slide_number: result["slide_number"],
-          title_showing: result["title_showing"],
-          default_body_item: result["default_body_item"],
-          default_title_item: result["default_title_item"],
-          presenter_notes: result["presenter_notes"],
-          transition_properties: result["transition_properties"],
-        )
-      end
-    end
-
-    # arguments is not implemented
-    # It will support title, body, ... or so on.
-    def append_slide(master_slide_name, arguments = {})
-      raise ArgumentError.new "nil master_slide_name is given" unless master_slide_name
-
-      result = eval_script <<-APPLE.unindent
-        var Keynote = Application("Keynote")
-        var doc = Keynote.documents.byId("#{self.id}")
-        var masterSlide = doc.masterSlides.whose({name: "#{master_slide_name}"}).first
-        var slide = Keynote.Slide({ baseSlide: masterSlide })
-        doc.slides.push(slide)
-        slide = doc.slides()[doc.slides().length - 1]
-
-        var slideResult = {
-          body_showing: slide.bodyShowing(),
-          skipped: slide.skipped(),
-          slide_number: slide.slideNumber(),
-          title_showing: slide.titleShowing(),
-          default_body_item: slide.defaultBodyItem(),
-          default_title_item: slide.defaultTitleItem(),
-          presenter_notes: slide.presenterNotes(),
-          transition_properties: slide.transitionProperties()
-        }
-        JSON.stringify(slideResult)
-      APPLE
-
-      slide = Slide.new(
-        base_slide: MasterSlide.new(master_slide_name),
-        body_showing: result["body_showing"],
-        skipped: result["skipped"],
-        slide_number: result["slide_number"],
-        title_showing: result["title_showing"],
-        default_body_item: result["default_body_item"],
-        default_title_item: result["default_title_item"],
-        presenter_notes: result["presenter_notes"],
-        transition_properties: result["transition_properties"],
+      @slides = SlideArray.new(
+        results.map do |result|
+          Slide.new(
+            MasterSlide.new(result["base_slide"]),
+            document: self,
+            body_showing: result["body_showing"],
+            skipped: result["skipped"],
+            slide_number: result["slide_number"],
+            title_showing: result["title_showing"],
+            body: result["body"],
+            title: result["title"],
+            presenter_notes: result["presenter_notes"],
+            transition_properties: result["transition_properties"],
+          )
+        end
       )
-      @slides << slide
+      @slides.document = self
+      @slides
     end
 
     def save
@@ -182,17 +148,33 @@ module Keynote
       self.new(symbolize_keys(result).merge(theme: theme, width: width, height: height))
     end
 
+    def self.all
+      self.find_with_conditions
+    end
+
     def self.find_by(args)
       raise ArgumentError.new('nil argument is given') unless args
 
       if args.is_a?(Hash) && args.has_key?(:id)
         conditions = ".whose({ id: '#{args[:id]}' })"
-      elsif args == :all
-        conditions = ''
       else
         raise ArgumentError.new('Unsupported argument is given')
       end
 
+      find_with_conditions(conditions)
+    end
+
+    def self.current
+      self.all.first
+    end
+
+    private
+
+    def self.symbolize_keys(hash)
+      Hash[hash.map { |k, v| [k.to_sym, v] }]
+    end
+
+    def self.find_with_conditions(conditions = '')
       results = eval_script <<-APPLE.unindent
         var documents = Application("Keynote").documents#{conditions};
         var results = [];
@@ -208,15 +190,5 @@ module Keynote
         self.new(symbolize_keys(result))
       end
     end
-
-    def self.current
-      self.find_by(:all).first
-    end
-
-    private
-
-    def self.symbolize_keys(hash)
-      Hash[hash.map { |k, v| [k.to_sym, v] }]
-    end
   end
 end

data/lib/keynote/slide.rb

@@ -7,22 +7,49 @@ module Keynote
     include Keynote::Util
 
     attr_accessor(
-      :id,
+      :document,
       :base_slide,
       :body_showing,
       :skipped,
       :slide_number,
       :title_showing,
-      :default_body_item,
-      :default_title_item,
+      :body,
+      :title,
       :presenter_notes,
       :transition_properties,
     )
 
-    def initialize(arguments = {})
+    def initialize(base_slide, arguments = {})
+      @base_slide = base_slide
       arguments.each do |attr, val|
         send("#{attr}=", val)
       end
     end
+
+    def title=(title)
+      @title = title
+      return unless @document
+      return unless @slide_number
+      result = eval_script <<-APPLE.unindent
+        var Keynote = Application("Keynote")
+        var doc = Keynote.documents.byId("#{@document.id}")
+        var slide = doc.slides()[#{@slide_number - 1}]
+        slide.defaultTitleItem.objectText = "#{title}"
+        JSON.stringify({ result: true })
+      APPLE
+    end
+
+    def body=(body)
+      @body = body
+      return unless @document
+      return unless @slide_number
+      result = eval_script <<-APPLE.unindent
+        var Keynote = Application("Keynote")
+        var doc = Keynote.documents.byId("#{@document.id}")
+        var slide = doc.slides()[#{@slide_number - 1}]
+        slide.defaultBodyItem.objectText = "#{body}"
+        JSON.stringify({ result: true })
+      APPLE
+    end
   end
 end

data/lib/keynote/slide_array.rb

@@ -0,0 +1,53 @@
+require 'unindent'
+require 'keynote/util'
+
+module Keynote
+  module ArrayMethods
+    def <<(slide)
+      raise ArgumentError.new "master_slide_name is not specified" unless slide.base_slide
+
+      title = slide.title.gsub(/(\r\n|\r|\n)/) { '\\n' }
+      body  = slide.body.gsub(/(\r\n|\r|\n)/) { '\\n' }
+
+      result = eval_script <<-APPLE.unindent
+        var Keynote = Application("Keynote")
+        var doc = Keynote.documents.byId("#{self.document.id}")
+        var masterSlide = doc.masterSlides.whose({name: "#{slide.base_slide}"}).first
+        var slide = Keynote.Slide({ baseSlide: masterSlide })
+        doc.slides.push(slide)
+        slide = doc.slides()[doc.slides().length - 1]
+        slide.defaultTitleItem.objectText = "#{title}"
+        slide.defaultBodyItem.objectText = "#{body}"
+
+        var slideResult = {
+          body_showing: slide.bodyShowing(),
+          skipped: slide.skipped(),
+          slide_number: slide.slideNumber(),
+          title_showing: slide.titleShowing(),
+          body: slide.defaultBodyItem.objectText(),
+          title: slide.defaultTitleItem.objectText(),
+          presenter_notes: slide.presenterNotes(),
+          transition_properties: slide.transitionProperties()
+        }
+        JSON.stringify(slideResult)
+      APPLE
+
+      slide.document = self.document
+      slide.body_showing = result["body_showing"]
+      slide.skipped = result["skipped"]
+      slide.slide_number = result["slide_number"]
+      slide.title_showing = result["title_showing"]
+      slide.presenter_notes = result["presenter_notes"]
+      slide.transition_properties = result["transition_properties"]
+
+      super
+    end
+  end
+
+  class SlideArray < Array
+    prepend ArrayMethods
+    attr_accessor :document
+
+    include Keynote::Util
+  end
+end

data/lib/keynote/theme.rb

@@ -13,7 +13,11 @@ module Keynote
     end
 
     def self.default
-      self.find_by(:all).first
+      self.all.first
+    end
+
+    def self.all
+      self.find_with_conditions
     end
 
     def self.find_by(args)
@@ -21,12 +25,16 @@ module Keynote
 
       if args.is_a?(Hash) && args.has_key?(:name)
         conditions = ".whose({ name: '#{args[:name]}' })"
-      elsif args == :all
-        conditions = ''
       else
         raise ArgumentError.new('Unsupported argument is given')
       end
 
+      find_with_conditions(conditions)
+    end
+
+    private
+
+    def self.find_with_conditions(conditions = '')
       results = eval_script <<-APPLE.unindent
         var themes = Application("Keynote").themes#{conditions};
         var results = [];

data/lib/keynote/version.rb

@@ -1,5 +1,5 @@
 module Keynote
   module Client
-    VERSION = "0.0.2"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keynote-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - ryo katsuma
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-11 00:00:00.000000000 Z
+date: 2015-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,6 +100,7 @@ files:
 - lib/keynote/document.rb
 - lib/keynote/master_slide.rb
 - lib/keynote/slide.rb
+- lib/keynote/slide_array.rb
 - lib/keynote/theme.rb
 - lib/keynote/util.rb
 - lib/keynote/version.rb
@@ -125,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: keynote client with high level API.