tads6_picolo 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5b20f71425a55ab01c8e966f0fd1b1e92256734b1f50cab91d8051d437678a3
-  data.tar.gz: cfbc62d25a03754986ccf24e305fb2a8602442af119e1b9c902d0017950f6a7f
+  metadata.gz: 2400cfa1a6332d8a0aa2db00165f191093707b560bb33bce3f18b494f8fe0bc1
+  data.tar.gz: 9bf9992bc746bffd6c2b5c6200804248ddca69d1245adc31820205793cef61d5
 SHA512:
-  metadata.gz: 608877e70badec221f2e775767af16c841adc1a27c580593f7627ab6b3727deb53bda9a1a6372b91ab61395872a6c34eb50e67804063fd40ad276e4a6a8a8eed
-  data.tar.gz: 2dc8f7e744c00e7d7b89b064fbc8a491bf80c3e5b33c29849ceefef5cd548bb9886be36523b8df49a580239d30c338f4543581d6c9d5ce0c6956a07c8b5fb823
+  metadata.gz: e9c0cfe5c5bf2ba125e23c2bab6b749f8a118009ab81e9ddc30837e80d7fe05abdc79387a03cbe7a0436c4f968a201f64c7552595d2e31ba373d8d9f8099731d
+  data.tar.gz: 4584a31752c2a5ff5c84a70520a863850638fa84e3314b89bccab95df3f9cc5f32ea6c12e2629179fb1ca467714a71a8d3cc8a545044a00dfbd27ad3449d0276

data/.gitignore

@@ -12,3 +12,4 @@
 
 *.gem
 /spec/support/tmp/db/livros/*.yml
+/example/db/carros/*.yml

data/README.md

@@ -1,43 +1,102 @@
 # Tads6Picolo
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tads6_picolo`. To experiment with that code, run `bin/console` for an interactive prompt.
+Este pequeno projeto foi desenvolvido como parte das aulas de Tópicos Especiais em Tecnologia da Informação no Institulo Federal de Mato Grosso do Sul Campus de Naviraí.
 
-TODO: Delete this and the text above, and describe your gem
+A gem tem como objeto demostrar aos estudantes o uso e a aplicação de bibliotecas (gem) para o encapsulamento funcionalidades genéricas que podem ser utilizadas em outros projetos. Outro objetivo atrelado a esta atividade relaciona-se ao conteúdo teórico sobre ORM (Mapeamento Objeto Relacional), os quais foram apresentados em aula e aplicados de forma prática neste trabalho.
 
-## Installation
+## Instalação
 
-Add this line to your application's Gemfile:
+Caso use um arquivo Gemfile, adicione o código abaixo:
 
 ```ruby
 gem 'tads6_picolo'
 ```
 
-And then execute:
+Logo após instale as dependências:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
+Ou, instale diretamente executando o código abaixo em seu terminal:
 
     $ gem install tads6_picolo
 
-## Usage
+## Como utilizar
 
-TODO: Write usage instructions here
+Para utilizar a `gem` deve-se realizar os seguintes passos:
 
-## Development
+Primeiro crie um novo arquivo e adicione uma classe a qual você deseja persistir seguindo as especificações abaixo:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+# Require necessário
+require 'tads6_picolo'
+
+# Sua classe deve herdar a classe Tads6Picolo::ORM
+class Livro < Tads6Picolo::ORM
+  # Toda classe deve conter um :ID obrigatoriamente
+  attr_accessor :id, :modelo
+
+  # O construtor deve seguir o exemplo abaixo
+  def initialize(hash)
+    @titulo = hash.first[:modelo]
+  end
+
+  # Este método deve ser reescrito obrigatoriamente com o
+  # caminho para seu banco de dados 'db/carros'
+  def self.path
+    'local/onde/deseja/salvar/os/dados'
+  end
+end
+```
+
+## Passo a Passo
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Crie o diretório com o caminho especificado no método `self.path`
+
+### Criar um novo registro:
+```ruby
+Carro.criar(
+  modelo: 'Fusca 5000'
+)
+```
 
-## Contributing
+### Listar todos os registros:
+```ruby
+puts Carro.listar
+```
+
+### Selecionar um registro específico
+```ruby
+puts Carro.selecionar(1)
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/luizpicolo/tads6_picolo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+### Atualizar um registro específico
+```ruby
+carro = Carro.selecionar(1)
+carro.modelo = "novo modelo"
+Carro.atualizar(carro)
+```
+
+### Remover um registro específico
+```ruby
+Carro.remove(1)
+```
+
+## Importante
+
+ - O atributo id deve estar contido, contudo ele não deve ser inicializado.
+ - O método path obrigatoriamente deve ser reescrito para o local onde você deseja salvar os dados
+
+```ruby
+  def self.path
+    'local/onde/deseja/salvar/os/dados'
+  end
+```
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+A gem está disponível como código aberto sob os termos do [MIT License](https://opensource.org/licenses/MIT).
 
 ## Code of Conduct
 
-Everyone interacting in the Tads6Picolo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tads6_picolo/blob/master/CODE_OF_CONDUCT.md).
+Espera-se que todos que interagem nas bases de código do projeto Tads6Picolo, rastreadores de problemas, salas de bate-papo e listas de discussão sigam as
+ [code of conduct](https://github.com/luizpicolo/tads6_picolo/blob/master/CODE_OF_CONDUCT.md).

data/example/example.rb

@@ -0,0 +1,32 @@
+require 'tads6_picolo'
+
+class Carro < Tads6Picolo::ORM
+  attr_accessor :id, :modelo
+
+  def initialize(hash)
+    @modelo = hash.first[:modelo]
+  end
+
+  def self.path
+     "db/carros"
+  end
+end
+
+# Criar um novo carro
+# Carro.criar(
+#   modelo: 'Fusca'
+# )
+
+# Listar todos os carros
+# puts Carro.listar
+
+# Selecionar um carro pelo id
+# puts Carro.selecionar(1)
+
+# Atualizar um carro existente
+# carro = Carro.selecionar(1)
+# carro.modelo = "novo modelo"
+# Carro.atualizar(carro)
+
+# Remover carro
+# Carro.remove(1)

data/lib/tads6_picolo.rb

@@ -1,6 +1,7 @@
 require "tads6_picolo/version"
 require "tads6_picolo/orm"
 require 'yaml'
+require 'FileUtils'
 
 module Tads6Picolo
   # Your code goes here...

data/lib/tads6_picolo/version.rb

@@ -1,3 +1,3 @@
 module Tads6Picolo
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tads6_picolo
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Luiz Picolo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-03 00:00:00.000000000 Z
+date: 2018-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,6 +70,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- example/example.rb
 - lib/tads6_picolo.rb
 - lib/tads6_picolo/orm.rb
 - lib/tads6_picolo/version.rb