rabbit-slide-giosakti-201710-coding-conventions-ruby 2017.10.16.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dabfcf2e7e2ce582669e6e18e9c59ffc695c4d7d
+  data.tar.gz: 839fa58562620cd3d14efb599b85189e0028747d
+SHA512:
+  metadata.gz: 7207e6359e956db3a3143448efe53377895268259b840d2d49d08c91d61289fa14857ca9b820be28e2a05d44b30e13879fbaea6b0a5714fd33e9748e5c551832
+  data.tar.gz: 3732a9322fb7048fb03a0e0fc5e42350c4a602ea95fc564ac6ebb9253bafd135641c27f8042178b69536327c9ab2044f74c5335eca1f7fa4b58dd049ac882fa6

data/.rabbit

@@ -0,0 +1 @@
+coding-conventions-ruby.rab

data/README.md

@@ -0,0 +1,36 @@
+# Coding Conventions in Ruby
+
+This talk gives intro about coding conventions and how can it be enforced in ruby.
+
+## License
+
+### Slide
+
+MIT
+
+Use the followings for notation of the author:
+
+  * Giovanni Sakti
+
+## For author
+
+### Show
+
+    rake
+
+### Publish
+
+    rake publish
+
+    # or for rubygems only
+    rake publish:rubygems
+
+## For viewers
+
+### Install
+
+    gem install rabbit-slide-giosakti-201710-coding-conventions-ruby
+
+### Show
+
+    rabbit rabbit-slide-giosakti-201710-coding-conventions-ruby.gem

data/Rakefile

@@ -0,0 +1,20 @@
+require "rabbit/task/slide"
+
+# Edit ./config.yaml to customize meta data
+
+spec = nil
+Rabbit::Task::Slide.new do |task|
+  spec = task.spec
+  spec.files += Dir.glob("images/**/*.*")
+  # spec.files -= Dir.glob("private/**/*.*")
+
+  # You may include other themes here
+  # spec.add_runtime_dependency("rabbit-theme-nyankosakana")
+  # spec.add_runtime_dependency("rabbit-theme-yart")
+end
+
+desc "Tag #{spec.version}"
+task :tag do
+  sh("git", "tag", "-a", spec.version.to_s, "-m", "Publish #{spec.version}")
+  sh("git", "push", "--tags")
+end

data/coding-conventions-ruby.rab

@@ -0,0 +1,129 @@
+= Coding Conventions in Ruby
+
+% : subtitle
+%   in Ruby
+: author
+   Giovanni Sakti
+: institution
+   Starqle
+% : content-source
+%    id_ruby
+% : date
+%    2017-10-16
+: theme
+   .
+
+= Coding Conventions
+
+(('tag:center'))What is coding conventions?
+
+== properties
+  : hide-title
+    true
+
+= Coding Conventions
+
+  * A set of guidelines
+  * for specific programming languages
+  * recommend programming styles, practics and methods
+
+= What does it cover?
+
+  * file organization
+  * indentation
+  * comments
+  * declarations
+  * statements
+
+= What does it cover? (cont'd)
+
+  * white space
+  * naming conventions
+  * practices & principles
+  * architectural
+  * etc
+
+= Applies
+
+(('tag:center'))Coding conventions may be applied to ((*organization*)), ((*specific project*)) or ((*specific product*))
+
+== properties
+  : hide-title
+    true
+
+= Benefits
+
+  * Improve readability
+  * Make software maintenance easier
+
+= Rationale
+
+  * 40-80% of the lifetime cost of a piece of software ((*goes to maintenance*))
+  * Hardly any software is maintained for its whole life by the original author
+
+= Rationale (cont'd)
+
+  * Code conventions ((*improve the readability*)) of the software, allowing engineers to understand new code more quickly and thoroughly
+  * If you ship your source code as a product, you need to make sure it is as well packaged and clean as any other product you create
+
+= In Practice
+
+(('tag:center'))Conventions may be formalized in a documented set of rules or may be as informal as the habitual coding practices of an individual
+
+== properties
+  : hide-title
+    true
+
+= Ruby Style Guide
+
+Ruby has coding conventions document called the ((*Ruby Style Guide*)) that serve as a generic reference for Ruby programmer\n
+
+((<"github.com/bbatsov/ruby-style-guide"|URL:github.com/bbatsov/ruby-style-guide>))
+
+= RuboCop
+
+(('tag:center'))Ruby also has interesting software to enforce coding convention called ((*RuboCop*))
+
+= Installing RuboCop
+
+  # rouge console
+
+  % gem install rubocop
+
+= Using RuboCop
+
+  # rouge console
+
+  % rubocop <file-name>
+
+= Default Style Guide
+
+By default, RuboCop use the ruby style guide as the default configuration
+
+= Custom Style Guide
+
+If you want to customize the style guide, you can create a ((*.rubocop.yml*)) in the same directory where you run rubocop
+
+= Custom Style Guide
+
+You can use following default configuration file of RuboCop as reference to create .rubocop.yml
+
+((<"github.com/bbatsov/rubocop/blob/master/config/default.yml"|URL:github.com/bbatsov/rubocop/blob/master/config/default.yml>))
+
+= Custom Style Guide
+
+Consult the following url for more info about configuration
+
+((<"rubocop.readthedocs.io/en/latest/configuration"|URL:http://rubocop.readthedocs.io/en/latest/configuration/>))
+
+= Exercise
+
+Implement a custom ((*.rubocop.yml*)) configuration file according to your organization convention
+
+= Thanks
+
+(('tag:center'))Thanks
+
+== properties
+  : hide-title
+    true

data/config.yaml

@@ -0,0 +1,23 @@
+---
+id: 201710-coding-conventions-ruby
+base_name: 201710-coding-conventions-ruby
+tags:
+- rabbit
+- ruby
+- rspec
+presentation_date: 2017-10-16
+version: 2017.10.16.1
+licenses:
+- MIT
+slideshare_id:
+speaker_deck_id: 
+ustream_id: 
+vimeo_id: 
+youtube_id: 
+author:
+  markup_language: :rd
+  name: Giovanni Sakti
+  email: giosakti@gmail.com
+  rubygems_user: giosakti
+  slideshare_user:
+  speaker_deck_user: giosakti 

data/theme.rb

@@ -0,0 +1,24 @@
+@margin_left = screen_x(1)
+@margin_right = screen_x(1)
+
+# @title_slide_title_font_size = @large_font_size
+# @title_slide_subtitle_font_size = @small_font_size
+
+match(Slide, HeadLine) do |headlines|
+  headlines.horizontal_centering = true
+
+  # This code below already available as default theme
+  # I put it here to show on how to style specific slide
+  # headlines.each do |headline|
+  #   slide = headline.slide
+  #   headline.hide if slide["hide-title"] == true
+  # end
+end
+
+match(Slide, Body) do |bodies|
+  bodies.vertical_centering = true
+end
+
+include_theme("default")
+# include_theme("rabbit-theme-nyankosakana")
+# include_theme("rabbit-theme-yart")

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: rabbit-slide-giosakti-201710-coding-conventions-ruby
+version: !ruby/object:Gem::Version
+  version: 2017.10.16.1
+platform: ruby
+authors:
+- Giovanni Sakti
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rabbit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+description: This talk gives intro about coding conventions and how can it be enforced
+  in ruby.
+email:
+- giosakti@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rabbit"
+- README.md
+- Rakefile
+- coding-conventions-ruby.rab
+- config.yaml
+- pdf/201710-coding-conventions-ruby-201710-coding-conventions-ruby.pdf
+- theme.rb
+homepage: http://slide.rabbit-shocker.org/authors/giosakti/201710-coding-conventions-ruby/
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Coding Conventions in Ruby
+test_files: []