voog-kit 0.2.1 → 0.2.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: ac0a57de7355211889a4cec2cd4c62b405e5f2ac
4
- data.tar.gz: 524285b8c42a5f49aa0bfbbdd6e5bb46172e5a82
3
+ metadata.gz: 6ca9d43de96a85cceacfc9ca445810fff9a51f9c
4
+ data.tar.gz: 3c9c89d32194b02a8a6cb0eea78c409a102d3a2f
5
5
  SHA512:
6
- metadata.gz: b47f316dc4afa5877e979e46363c2497047ccb04a9b4beba5694c182466b8967c54d558842ba9f7563c1808aa7efa31b869d757cf202bb7eeba308fd61f7706c
7
- data.tar.gz: 2b18928b4acf862ab8857094c1eb007dacd1cea452d19280907edbc298aab3d947ad0bcc9edb4d1fff2de631639062e033169554443eedb00af1af1476aedf5d
6
+ metadata.gz: fa8c0fc65383f9d0a5bd47cd673ee097f3396de404c2e317322633a159ee4b05172cde28a91e055c3e1112baa8e742667e9b705b0e0ab9208cc23fa46a22f952
7
+ data.tar.gz: bf8576c04f7c357633196fa44dd8431874140a01cfaa7729d5f9f7a014fc7b02db63062edc1d4fe816af4d3bfe63d1255f620fe6d172315c45e6adca30f03352
data/README.markdown CHANGED
@@ -38,12 +38,11 @@ at `mysite.voog.com`. This is essentially all you need to get started.
38
38
 
39
39
  ### Downloading the layout
40
40
 
41
- Let's start.
41
+ `kit pull -h mysite.voog.com -t 0809d0c93c53438d435b2073d2cf2d22`
42
42
 
43
- `kit pull -h mysite.voog.com -t 0809d0c93c53438d435b2073d2cf2d22` downloads the layout files
44
- from *mysite.voog.com* using the API token *0809d0c93c53438d435b2073d2cf2d22*. This creates
45
- the necessary folders to hold the files, so the file structure stays the same as in the
46
- online code editor.
43
+ This downloads the layout files from *mysite.voog.com* using the API token
44
+ *0809d0c93c53438d435b2073d2cf2d22*. This creates the necessary folders to hold the
45
+ files, so the file structure stays the same as in the online code editor.
47
46
 
48
47
  The current folder structure should be something like this:
49
48
  ```
@@ -56,15 +55,51 @@ The current folder structure should be something like this:
56
55
  stylesheets/
57
56
  ```
58
57
 
59
- As you can see, kit also generated a *manifest.json* file to hold the metadata to along with
58
+ As you can see, **kit** also generated a *manifest.json* file to hold the metadata to along with
60
59
  the layout files. This is later used when checking for missing files and uploading everything back up.
61
60
 
62
61
  There's also a *.voog* file that holds your hostname and API token so you don't have to provide them
63
62
  every time:
64
63
 
64
+ ```
65
+ [mysite.voog.com]
66
+ host=mysite.voog.com
67
+ api_token=0809d0c93c53438d435b2073d2cf2d22
68
+ overwrite=false
69
+ ```
70
+
71
+ The site name inside the square brackets, [mysite.voog.com] is set as a default.
72
+ You can change it to whatever you want. If you only have one site to work with within
73
+ the current folder, you don't have to worry about it. When you do, however, have multiple
74
+ sites with the same layout, it's useful to have meaningful names for each configuration block.
75
+
76
+ To specify which block to use, you can provide it with the `--site` or `-s` options like so:
77
+
78
+ `kit pull -s mysite.voog.com`
79
+
80
+ This looks for a configuration file block with the same name
81
+ and uses the hostname and API token given there.
65
82
 
66
83
  ### Uploading the changes
67
84
 
85
+ After making the changes, you'll want to upload them to your site. This is done via `kit push`.
86
+ The possible arguments are same as before: you can provide the hostname and token manually with
87
+ `-h / --host` and `-t / --token`, or just provide the configuration block name found in the *.voog*
88
+ file with the `-s / --site` option.
89
+
90
+ Let's use the last option: `kit push --site=mysite.voog.com`. This lists all the files
91
+ that are updated. By default, all files are updated at once, but if you only made changes to a few, you
92
+ can provide them explicitly like so: `kit push stylesheets/main.css javascripts/main.js`. This saves
93
+ time (and bandwidth) as there's only a few files being uploaded.
94
+
95
+ ### Automating
96
+
97
+ As you've learned, pushing and pulling files is super easy, but it's still something you
98
+ have to do every time you change something and want to see the changes take place.
99
+ To counter this, `kit` provides a handy `watch` command that monitors your local files
100
+ and pushes them up if it sees any changes. The arguments to this command are, again, the
101
+ same as before. To stop watching, just type "exit" or press Ctrl+D.
102
+
68
103
  ## Commands
69
104
 
70
105
  * `init` - Initializes the local folder structure and files for a site
@@ -75,32 +110,10 @@ every time:
75
110
  * `watch` - Watches for file changes in the current directory
76
111
  * `help` - Shows a list of commands or help for one command
77
112
 
78
- Most commands need to know your site's URL and you personal API token to properly authorize all
79
- requests. For this you can either provide them with `--token/-t` and `--host/-h`
80
- flags, e.g `kit pull -t 0809d0c93c53438d435b2073d2cf2d22 -h mysite.voog.com`. If there's a '.voog' file
81
- present in the current folder, it takes the options from there.
82
-
83
- There's also a `--site/-s` argument that is used to choose a configuration block from the `.voog` file.
84
-
85
- Example `.voog` file:
86
-
87
- ```
88
- [site1]
89
- host=mysite.voog.com
90
- api_token=0809d0c93c53438d435b2073d2cf2d22
91
- [site2]
92
- host=site2.customdomain.co
93
- api_token=5d390d7d4552d14afcf30182aecfc815
94
- ```
95
-
96
- To choose the second block, you can simply use `kit pull -s site2` or `kit pull --site=site2`.
97
- If the site is not provided, **kit** will use the first block defined in the file.
98
- When you provide the host, token and block name, it is then written to the configuration file, overwriting
99
- any identically named blocks or creating a new one, if necessary.
100
-
101
- If the configuration file isn't present and you provide the token, hostname and site name manually when invoking a
102
- command, the file is then generated and the options are stored within so you don't have to provide them
103
- later.
113
+ Most of these commands use the same options as shown before:
114
+ `--site / -s` - provide a configuration block name
115
+ `--host / -h` - provide a hostname
116
+ `--token / -t` - provide your API token to authorize all requests
104
117
 
105
118
  Another useful option is `--overwrite` to allow updating asset files you normally couldn't update. This deletes the
106
119
  old file and uploads the newer one as a replacement. This cannot be undone, so take caution!
@@ -161,30 +174,7 @@ You can stop the watch command by pressing Ctrl+D or typing "exit" or "q".
161
174
  This command shows helpful information about the tool or its subcommands. Invoking `kit help` shows a list of possible
162
175
  options and commands with a brief description. `kit help <command>` shows information about that command.
163
176
 
164
- ### Sample local folder structure
165
177
 
166
- ```
167
- ./
168
- assets/
169
- custom_font.woff
170
- components/
171
- mainmenu.tpl
172
- sidebar.tpl
173
- footer.tpl
174
- images/
175
- background.jpg
176
- javascripts/
177
- custom_script.js
178
- spinner.js
179
- layouts/
180
- front_page.tpl
181
- blog.tpl
182
- products.tpl
183
- stylesheets/
184
- style.css
185
- .voog
186
- manifest.json
187
- ```
188
178
 
189
179
  If you want to explicitly use latest version of the [Voog API client](https://github.com/Edicy/voog.rb):
190
180
 
@@ -1,5 +1,5 @@
1
1
  module Voog
2
2
  module Dtk
3
- VERSION = '0.2.1'
3
+ VERSION = '0.2.2'
4
4
  end
5
5
  end
data/voog-kit.gemspec CHANGED
@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
31
31
  spec.add_runtime_dependency 'voog_api', '~> 0.0.7'
32
32
  spec.add_runtime_dependency 'colorize'
33
33
  spec.add_runtime_dependency 'mime-types', '~> 1.25.1'
34
+ spec.add_runtime_dependency 'rb-readline'
34
35
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: voog-kit
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.1
4
+ version: 0.2.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Mikk Pristavka
@@ -165,6 +165,20 @@ dependencies:
165
165
  - - "~>"
166
166
  - !ruby/object:Gem::Version
167
167
  version: 1.25.1
168
+ - !ruby/object:Gem::Dependency
169
+ name: rb-readline
170
+ requirement: !ruby/object:Gem::Requirement
171
+ requirements:
172
+ - - ">="
173
+ - !ruby/object:Gem::Version
174
+ version: '0'
175
+ type: :runtime
176
+ prerelease: false
177
+ version_requirements: !ruby/object:Gem::Requirement
178
+ requirements:
179
+ - - ">="
180
+ - !ruby/object:Gem::Version
181
+ version: '0'
168
182
  description: Tools that help Voog design development
169
183
  email:
170
184
  - mikk@fraktal.ee