hive-toolbelt 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c7c1c2827f31a895cf3c4a926b254c49f52923b
-  data.tar.gz: af63873df27ee4aaf8d3ba5675792a5aeecdbe0a
+  metadata.gz: 8d6b49afa5e8f06227fc8b620720ece2b40a9fbb
+  data.tar.gz: c95ade148f4b030a682cd95b1ba402e39f619704
 SHA512:
-  metadata.gz: 1f149d1426c56a68ad33b3e837f61c55dd8fc4c1415e5874e64a13c4dcef96ac7ea23eee01938644f01b24cb1432aa5b5a5d51dcc135bebab4e99365c7e95701
-  data.tar.gz: 6f49a4f13d008eef4cb57f2827a8e9e44c38b2d307fed2c06068d0a1c95277689017a5966df8aeb4eaf393acf2b034d44fdf90ccaca85bc429d9bf1a90f4124e
+  metadata.gz: 69d05972959dc82561b4734d57a14a36531b47f823c15521074efe1df4c40cec167bfd45c274481c3db13764069a4ceb929cc461044964b528252d7fc59981d7
+  data.tar.gz: 687f25bef4af32db4622c6d99eadb656dd52dac81e08c7aa728cb4e1102cdebf7a38765bb81e4bc7142eb47ea5be3801a70d87c039ecaaa60e1f11b8c8c2272b

data/README.md

@@ -12,6 +12,26 @@ Command Line Interface for the Hive wallet
     $ hive package  # creates a .hiveapp bundle from specified or current working directory (.hidden files ignored)
     $ hive release  # (TODO) bumps version, tags and pushes
 
+### hive init
+
+    $ mkdir new_app
+    $ cd new_app
+    $ hive init
+
+`hive init` asks questions and scaffolds a Hive app. It
+
+- creates manifest.json. Read more on [manifest configuration](https://github.com/hivewallet/hive-osx/wiki/How-to-build-a-Hive-app#wiki-manifest-file) 
+- creates a skeleton index.html. Read more on [index.html](https://github.com/hivewallet/hive-osx/wiki/How-to-build-a-Hive-app#wiki-index-page)
+- provides a default icon
+- generates basic app structure. Read more on [app structure](https://github.com/hivewallet/hive-osx/wiki/How-to-build-a-Hive-app#wiki-app-structure)
+- includes a [mock Hive API](https://github.com/javgh/hiveapp-api-mock/blob/v1.0.1/hiveapp-api-mock.js) for in-browser development & testing
+ 
+### hive package
+
+`hive package [DIR_NAME]` packages a directory into a .hiveapp bundle. `DIR_NAME` defaults to current working directory if not specified. Regardless of `DIR_NAME`, the generated `.hiveapp` bundle is always located at current working directory.
+
+Note that the command deliberately exclude all .hidden files and directories, like `.git`, when generating the bundle. 
+
 ## Contributing
 
 1. Fork it ( http://github.com/hivewallet/hive-toolbelt/fork )

data/lib/hive/toolbelt/cli.rb

@@ -10,6 +10,12 @@ I18n.enforce_available_locales = false
 module Hive
   module Toolbelt
     class CLI < Thor
+      MANIFEST = "manifest.json"
+      INDEX = "index.html"
+      ICON = "icon.png"
+      README = "README.md"
+      LICENSE = "MIT-LICENSE.txt"
+
       desc "init", "scaffold a Hive app"
       def init
         config = {}
@@ -34,7 +40,7 @@ module Hive
         directory = sanitize_dir_name dir_name
         check_for_required_files directory
 
-        bundle_name = bundle_name_from_manifest(File.join directory, 'manifest.json')
+        bundle_name = bundle_name_from_manifest(File.join directory, MANIFEST)
         FileUtils.rm(bundle_name) if File.exists? bundle_name
         bundle_files bundle_name, directory
 
@@ -50,11 +56,11 @@ module Hive
         def create_manifest config={}
           defaults = {
             version: "0.0.1",
-            icon: "icon.png",
+            icon: ICON,
             id: id_for(config[:author], config[:name])
           }
 
-          File.open('manifest.json', 'w') do |f|
+          File.open(MANIFEST, 'w') do |f|
             config[:accessedHosts] = config[:accessedHosts].split(',').map(&:strip)
             f.puts(JSON.pretty_generate config.merge(defaults))
           end
@@ -62,11 +68,11 @@ module Hive
 
         def id_for author, name
           return "" if author.blank? || name.blank?
-          "#{author.parameterize('_')}.#{name.parameterize('_')}"
+          "#{author.parameterize}.#{name.parameterize}"
         end
 
         def copy_default_icon
-          copy_file File.join('images', 'icon.png'), 'icon.png'
+          copy_file File.join('images', ICON), ICON
         end
 
         def copy_api_mock
@@ -75,19 +81,17 @@ module Hive
         end
 
         def create_index_html title
-          index_filename = 'index.html'
-          copy_file File.join('html', index_filename), index_filename
-          gsub_file index_filename, /{{title}}/, title
+          copy_file File.join('html', INDEX), INDEX
+          gsub_file INDEX, /{{title}}/, title
         end
 
         def create_readme config
-          readme_filename = 'README.md'
-          copy_file readme_filename, readme_filename
-          safe_gsub_file readme_filename, /{{name}}/, config[:name]
-          safe_gsub_file readme_filename, /{{description}}/, config[:description]
-          safe_gsub_file readme_filename, /{{app_id}}/, id_for(config[:author], config[:name])
-          safe_gsub_file readme_filename, /{{repo_url}}/, config[:repo_url]
-          safe_gsub_file readme_filename, /{{project_name}}/, project_name_from(config[:repo_url])
+          copy_file README, README
+          safe_gsub_file README, /{{name}}/, config[:name]
+          safe_gsub_file README, /{{description}}/, config[:description]
+          safe_gsub_file README, /{{app_id}}/, id_for(config[:author], config[:name])
+          safe_gsub_file README, /{{repo_url}}/, config[:repo_url]
+          safe_gsub_file README, /{{project_name}}/, project_name_from(config[:repo_url])
         end
 
         def safe_gsub_file filename, pattern, replacement
@@ -103,10 +107,9 @@ module Hive
         end
 
         def create_license author
-          license_filename = 'LICENSE.txt'
-          copy_file license_filename, license_filename
-          safe_gsub_file license_filename, /{{year}}/, Time.now.year.to_s
-          safe_gsub_file license_filename, /{{author}}/, author
+          copy_file LICENSE, LICENSE
+          safe_gsub_file LICENSE, /{{year}}/, Time.now.year.to_s
+          safe_gsub_file LICENSE, /{{author}}/, author
         end
 
         def create_empty_folders
@@ -122,7 +125,7 @@ module Hive
         end
 
         def check_for_required_files sanitized_dir_name
-          %w(index.html manifest.json).each do |filename|
+          [INDEX, MANIFEST].each do |filename|
             if Dir.glob(File.join sanitized_dir_name, filename).empty?
               raise PackageError.new("#{filename} is required. But it's not found under #{sanitized_dir_name}")
             end
@@ -142,7 +145,7 @@ module Hive
           required = config.slice :author, :name, :version
 
           required.each do |k, v|
-            raise PackageError.new("Please provide a value for `#{k}` field in manifest.json") if v.blank?
+            raise PackageError.new("Please provide a value for `#{k}` field in #{MANIFEST}") if v.blank?
           end
 
           required.values.join(' ').parameterize << '.hiveapp'

data/lib/hive/toolbelt/version.rb

@@ -1,5 +1,5 @@
 module Hive
   module Toolbelt
-    VERSION = "1.0.0"
+    VERSION = "2.0.0"
   end
 end

data/spec/lib/hive/toolbelt_spec.rb

@@ -36,7 +36,7 @@ module Hive::Toolbelt
 
         expect(manifest["version"]).to eq("0.0.1")
         expect(manifest["icon"]).to eq("icon.png")
-        expect(manifest["id"]).to eq("wei_lu.foo_app")
+        expect(manifest["id"]).to eq("wei-lu.foo-app")
       end
 
       describe 'accessedHosts' do
@@ -119,12 +119,12 @@ module Hive::Toolbelt
       it { expect(readme).to include(config[:name]) }
       it { expect(readme).to include(config[:description]) }
       it { expect(readme).to include("cd #{project_name}") }
-      it { expect(readme).to include("ln -s ~/#{project_name}/ wei_lu.foo_app") }
+      it { expect(readme).to include("ln -s ~/#{project_name}/ wei-lu.foo-app") }
       it { expect(readme).to include("git clone #{config[:repo_url]}") }
     end
 
     describe '#create_license' do
-      let(:filename) { 'LICENSE.txt' }
+      let(:filename) { 'MIT-LICENSE.txt' }
       let(:author) { 'Wei Lu' }
       let(:license) do
         cli.create_license author

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ RSpec.configure do |config|
   config.order = 'random'
 
   # clean up generated files
-  generated_files = %w(manifest.json icon.png index.html README.md LICENSE.txt wei-lu-my-app-1-0-1.hiveapp)
+  generated_files = %w(manifest.json icon.png index.html README.md MIT-LICENSE.txt wei-lu-my-app-1-0-1.hiveapp)
   generated_files << File.join('javascripts', 'hiveapp-api-mock.js')
   %w(stylesheets images fonts).each do |dirname|
     generated_files << File.join(dirname, '.gitignore')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hive-toolbelt
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Wei Lu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-13 00:00:00.000000000 Z
+date: 2014-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -122,7 +122,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- assets/LICENSE.txt
+- assets/MIT-LICENSE.txt
 - assets/README.md
 - assets/html/index.html
 - assets/images/icon.png