tkn2 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c47a9bc8f71f08d678661bd99720f72c2fdc065
-  data.tar.gz: 5700de099467bd9c1c45166a6ecdf7c189e1e474
+  metadata.gz: 5493112f82044e8673a8dd2a496c25ef9d1e7eef
+  data.tar.gz: 0c3fa66c4a402f5f9c65c9ea919cf76148d86622
 SHA512:
-  metadata.gz: be808afbf8b891c5f58e59f712829a85498a80ff9758b78797e149f3ef5c1280bd32a957c00dd475258be2ceb2c4ccf32cfb6601b8d120933dad87133fbac9c8
-  data.tar.gz: 41a2b35ebfef372eceb17213c39324cae3501e458c86521d8214fabcbe23dab3ffb683f47ff4caeb2bb9e065b1368a55e4f3eb22367f66c541812f35e8203a98
+  metadata.gz: d8a3a1c0651aad1537f43310dab8d7b6a9f8fd47f4841fe2507ff21fb556b680d0e1477ab8f731ffbdc641902e29b6bf1cc170b0b12075cb1a56abe00fd39377
+  data.tar.gz: 0f48252aff1bcb5b2f7e4c18e6408e859c4ff0fbee4408d24c7f184bae39e80f63083022f23f882b36a4e5a719ae894f7bdc97d1d510a839956bc4a20aa99fc2

data/README.md

@@ -22,8 +22,14 @@ Main differences with tkn:
 
 ## Usage
 
-Have a `.rb` file requiring `tkn2` with a `Tkn2.deck` block. In that block you can use all the available commands.
-You'll run that file to start the presentation
+Install tkn2 if you haven't, and run the generator to create a new deck:
+
+```
+$ gem install tkn2
+$ tkn2 new 'My slides'
+```
+
+This will create a directory called `my_slides/` which will contain your deck in the file `my_slides.rb`:
 
 ```ruby
 require 'tkn2'
@@ -33,18 +39,10 @@ Tkn2.deck do
 end
 ```
 
-The easiest way to do this is to have a `Gemfile` like this:
-
-```ruby
-source 'https://rubygems.org'
-
-gem 'tkn2'
-```
-
-And then run the presentation using bundler:
+To run the presentation:
 
 ```
-$ bundle exec ruby mypresentation.rb
+$ bundle exec ruby my_slides.rb
 ```
 
 ### Available commands
@@ -57,7 +55,8 @@ Generates a slide with the given text, centered line by line.
 
 ```ruby
 center <<-EOS
-  Tkn2 Less is more
+  Tkn2
+  Less is more
 EOS
 ```
 
@@ -121,7 +120,6 @@ That said:
 * Better control of *overflow* (currently the presentation crashes if the content doesn't fit in the screen). I'm
   playing with the idea of having *scroll*, something usually not present in graphical presentation software and that
   can be useful to present code without using a tiny font size
-* A generator
 * Colors and themes
 * Plugin system. More as an exercise, I want to try to keep the core small and simple and implement features as plugins
 * A way to compose slides with more than one element. Tools to generate content (ASCII art diagrams, etc.)

data/bin/tkn2

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+require 'thor'
+require 'tkn2/version'
+
+module Tkn2
+  class Cli < Thor
+    desc 'new TITLE', 'Generates a new deck named TITLE'
+
+    def new(title)
+      NewDeck.start([title])
+    end
+  end
+
+  class NewDeck < Thor::Group
+    include Thor::Actions
+
+    argument :title
+
+    def self.source_root
+      File.join(File.dirname(__FILE__), '..', 'lib', 'tkn2')
+    end
+
+    def create_gemfile
+      template 'templates/Gemfile.tt', "#{filename}/Gemfile"
+    end
+
+    def create_deck
+      template 'templates/deck.tt', "#{filename}/#{filename}.rb"
+    end
+
+    def create_readme
+      template 'templates/readme.tt', "#{filename}/README.md"
+    end
+
+    def install_bundle
+      inside filename do
+        run 'bundle install'
+      end
+    end
+
+    private
+
+    def version
+      Tkn2::VERSION
+    end
+
+    def filename
+      @filename ||= Thor::Util.snake_case(title).gsub(/\s+/, '_')
+    end
+  end
+end
+
+Tkn2::Cli.start

data/examples/constant_autoloading_in_ruby_on_rails.rb

@@ -1,3 +1,5 @@
+# originally taken from https://github.com/fxn/tkn/blob/master/examples/constant_autoloading_in_ruby_on_rails.rb
+
 require 'tkn2'
 
 Tkn2.deck do

data/lib/tkn2/templates/Gemfile.tt

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'tkn2', '<%= version %>'

data/lib/tkn2/templates/deck.tt

@@ -0,0 +1,5 @@
+require 'tkn2'
+
+Tkn2.deck do
+  center '<%= title %>'
+end

data/lib/tkn2/templates/readme.tt

@@ -0,0 +1,8 @@
+# <%= title %>
+
+Slides made with [Tkn2](https://github.com/porras/tkn2). To watch them, clone the repo, cd into it and run:
+
+```
+$ bundle install # [only the first time]
+$ bundle exec ruby <%= filename %>.rb
+```

data/lib/tkn2/version.rb

@@ -1,3 +1,3 @@
 module Tkn2
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/tkn2.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "pygments.rb"
+  spec.add_dependency "thor"
+  spec.add_dependency "bundler"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tkn2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Sergio Gil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-30 00:00:00.000000000 Z
+date: 2013-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pygments.rb
@@ -24,6 +24,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: bundler
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -55,7 +83,8 @@ dependencies:
 description: tkn2 is a terminal based presentation tool based on fxn's tkn
 email:
 - sgilperez@gmail.com
-executables: []
+executables:
+- tkn2
 extensions: []
 extra_rdoc_files: []
 files:
@@ -65,6 +94,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/tkn2
 - examples/constant_autoloading_in_ruby_on_rails.rb
 - examples/simple.rb
 - lib/tkn2.rb
@@ -73,6 +103,9 @@ files:
 - lib/tkn2/deck.rb
 - lib/tkn2/screen.rb
 - lib/tkn2/slide.rb
+- lib/tkn2/templates/Gemfile.tt
+- lib/tkn2/templates/deck.tt
+- lib/tkn2/templates/readme.tt
 - lib/tkn2/utils.rb
 - lib/tkn2/version.rb
 - tkn2.gemspec