Prepare for testing on AVD

apuokenas · Dec 18, 2014 · da5da77 · da5da77
1 parent 5694d6b
commit da5da77
Show file tree

Hide file tree

Showing 31 changed files with 214 additions and 174 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,29 +1,34 @@
-# built application files
+# Built application files
 *.apk
 *.ap_
 
-# files for the dex VM
+# Files for the Dalvik VM
 *.dex
 
 # Java class files
 *.class
 
-# generated files
+# Generated files
 bin/
 gen/
 
-# Local configuration file (sdk path, etc)
+# Local configuration file (Android SDK path, etc.)
 local.properties
 
 # Eclipse project files
 .classpath
 .project
 
-# Proguard folder generated by Eclipse
+# ProGuard folder generated by Eclipse
 proguard/
 
-# Intellij project files
+# IntelliJ project files
 *.iml
 *.ipr
 *.iws
 .idea/
+
+# Defaults for Android Studio
+.gradle
+.DS_Store
+/build
diff --git a/README.md b/README.md
@@ -1,144 +1,155 @@
-MaistoBankas
-============
+Maisto bankas
+=============
 
-MaistoBankas - skaitliukas maisto banko surinktų produktų statistikos rinkimui
+`PI;N` (angl. `TL;DR`)
 
-## Mokymų turinys / Užduotys
+Maisto produktų apskaitos programėlė "Maisto bankas": subalansuota "Maisto banko" savanoriams, bet tinka ir "Maltiečių ordino" virtuvių šefams bei kebabinių gaspadinėms!
+
+Programėlė "Maisto bankas" yra licencijuota pagal ["Apache License"](http://choosealicense.com/licenses/apache-2.0) sąlygas, vadinasi, programinę įrangą galima laisvai:
+* Naudoti bet kokiu tikslu.
+* Modifikuoti.
+* Platinti (tiek originalią, tiek modifikuotą versijas).
+Vienintelė ribojanti sąlyga - privaloma išsaugoti autorines teises ir atsišaukimą (jei toks yra) bei nereikalauti jokių autorinių honorarų.
+
+### Projekto techniniai niuansai
+
+Šiame dokumente galite susipažinti, kaip vyksta programėlės tobulinimas, apauginant ją nauju funkcionalumu ir koreguojant ar atsisakant senesnio, nebeatitinkančio vartotojų poreikių (arba bankrutavus kokiam nors API teikėjui).
+
+Idėjų semtasi iš kyborgų korifėjaus Viliaus Kraujučio 2014 m. vasarį "Vinted" patalpose vestų ["Android" mokymų](https://plus.google.com/u/0/events/c24nklguv5saguo9sj29mpbuo7g) mokymų, kurių metu buvo šnekučiuojamasi programuotojams skirtoje tarnyboje ["Gitter"](https://gitter.im).
 
-Sąrašiukas, kaip programėlė buvo tobulinama
 ### Programavimo aplinkos įdiegimas
 
-Tie kas atėjo pirmą kartą, reikėjo įsidiegti:
+Jei norite prisidėti, tobulinant aplikaciją, turite lokaliai įsidiegti:
+
+* Naujausią oficialią integruotą "Android" programavimo aplinką ["Android Studio"](http://developer.android.com/sdk/index.html).
+* Projekto *buildinimo* automatizavimo įrankį ["Gradle" (v2.2.1)](http://services.gradle.org/distributions/gradle-2.2.1-all.zip).
+* Programavimui "Java" kalba skirtą priemonę ["Java SE Development Kit 8"](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html).
 
-* Naujausią [Android Studio](http://developer.android.com/sdk/installing/studio.html)
-* [Gradle versiją 1.11](http://services.gradle.org/distributions/gradle-1.11-all.zip)
-* [Java JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk7-downloads-1880260.html)
+### "Android" programėlės generavimas
 
-### Susigeneruoti Android programėlę
+Pasinaudojus "Android Studio" vedliu, iš "GitHub" kodo versijavimo sistemos galima parsiųsti programėlės struktūrą:
 
- Pasinaudoti Android Studio vedliu ir susigeneruoti programėlės struktūrą.
+VCS --> Checkout from Version Control... --> GitHub.
 
- Pradėti File->New Project... ir sekti vedlio nurodymais.
+Atsidariusiame lange į "Vcs Version URL" laukelį įveskite:
+`https://github.com/apuokenas/MaistoBankas.git`,
+o kaip "Parent Directory" nurodykite vietinį aplanką, kuriame talpinsite projekto failus.
 
-Kas buvo pridėta ir komentarus galima pažiūrėti GitHub'o įrašuose:
-[Pakeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/fe1fe22e80ac50ddc991299c85b8f1f7313570f8)
+P. S. Savo mašinoje reikia turėti git.exe bylą, kurios adresas įvedamas per "Settings" meniu:
 
-### Layout komponentai pagrindiniame fragmente
+File --> Settings --> Version Control --> Git.
 
-Reikės pridėti:
+Lauke "Path to Git executable" nurodomas kelias iki minėto failo. Pvz., jei esate "Windows" vartotojas:
 
-- Nustatymų mygtuką, atidarantį parduotuvės informacijos suvedimo fragmentą
-- Mygtuką "Skenuoti"
-- Sąrašą nuskenuotų prekių vaizdavimui (ListView)
+C:\Users\[Vartotojas]\AppData\Local\GitHub\PortableGit_[40_raidžių_ir_skaičių]\bin\git.exe.
 
-[Pakeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/baa82d612e2f96e5e734829597f28922f93c2b88)
+Kodo modifikacijas ir susijusius komentarus galite peržiūrėti "GitHub" [pakeitimų įrašuose](https://github.com/apuokenas/MaistoBankas/commits).
 
-## Pridėti nustatymų fragmentą
+### `Layout` komponentai pagrindiniame `fragment`'e
 
-Paprasta forma, kurioje keletas įvedimo laukelių:
+* Mygtukas "Nustatymai", atidarantis produktų rinkimo (parduotuvės) arba valgių gaminimo vietos informacijos suvedimo `fragment`'ą.
+* Mygtukas "Skenuoti".
+* Sąrašas (`ListView`) nuskenuotų prekių išvedimui į ekraną.
+
+## "Nustatymų" `fragment`'o pridėjimas
+
+Tai paprasta forma, kurioje randami keli įvesties laukeliai:
 
 * Miestas
 * Adresas
-* Parduotuvės vardas
+* Parduotuvės pavadinimas
 * Savanorio vardas
-* ir mygtukas Išsaugoti
 
-[Pasikeitimai]
-(https://github.com/gdgvilnius/MaistoBankas/commit/686d64d19c0bd3889f45cf3eeec488290153dbff)
+Ir, žinoma, *mygelis* "Išsaugoti".
 
-## Pridėti Barcode skenerį
+## Brūkšninio kodo skenerio implementavimas
 
-Barkodų skenavimui integravome [ZXing](https://github.com/zxing/zxing)
-Skenavimą pasinaudojant Intent'ais.
-Žiūrėti instrukcijas, kaip integruoti [čia](https://github.com/zxing/zxing/wiki/Scanning-Via-Intent)
+Brūkšninius kodus skenuoja kita į "Knygų Kalėdas" integruota programėlė - ["ZXing"](https://github.com/zxing/zxing) (dar žinoma kaip "Zebra Crossing").
+Skenavimas vykdomas, naudojantis `Intent`'u.
+Instrukcijas, kaip visa tai integruoti, galite rasti [čia](https://github.com/zxing/zxing/wiki/Scanning-Via-Intent).
 
-## Pridėti Lifecycle loginimą (2014-02-08)
- Nusprendėm geriau suprasti Activity ir Fragment gyvavimo ciklą (lifecycle).
+## `Activity` gyvavimo ciklo registravimas
 
- Pažiūrėjome lifecycle diagramą [čia](http://developer.android.com/training/basics/activity-lifecycle/starting.html)
- Ir į `BaseActivity` įsidėsime `Log.d()` komandas šiuose metoduose:
- * OnCreate
- * OnStart
- * OnResume
- * OnPause
- * OnStop
- * OnDestroy
+Siekdamas geriau suprasti `Activity` ir `Fragment` gyvavimo ciklus (angl. *lifecycle*), peržiūrėjau atitinkamą [diagramą](http://developer.android.com/training/basics/activity-lifecycle/starting.html), kuria remiantis, įdėjau `Log.d()` komandas į `BaseActivity` šiuose metoduose:
+* OnCreate()
+* OnStart()
+* OnResume()
+* OnPause()
+* OnStop()
+* OnDestroy()
 
- [Pakeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/8a58e205d20fd3556cad6e6f3032397069718879)
+## `Fragment`'ų gyvavimo ciklo registravimas
 
- ## Fragmentų gyvavimo ciklo loginimas
- Analogiškai kaip ir su Activity gyvavimo ciklo loginimu,
- pasidarome ir Fragment'ų gyvavimo ciklo loginimą.
- Apie [Android Fragment lifecycle galima pasiskaityti android.com svetainėje]
-  (http://developer.android.com/guide/components/fragments.html)
+nalogiškai `Activity` gyvavimo ciklo *loginimo* atvejui, pasidariau `Fragment` gyvavimo ciklo registravimą.
+Apie `Fragment` gyvavimo ciklus galima pasiskaityti [oficialioje "Google" dokumentacijoje](http://developer.android.com/guide/components/fragments.html)
 
-Taigi reikės susikurti `BaseFragment` pagrindinę klasę,
-kurioje sudėsime loginimo metodus:
-* onAttach
-...
+Taigi reikia susikurti `BaseFragment` pagrindinę klasę, kurioje patalpinti *loginimo* metodai:
+* onAttach()
+* onCreate()
+* onCreateView()
+* onActivityCreated()
+* onStart()
+* onResume()
+* onPause()
+* onStop()
+* onDestroyView()
+* onDestroy()
+* onDetach()
 
-[Pasikeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/c6e9e5c208491567eb4879c13d7af52035a81498)
+## Duomenų bazės, skirtos saugoti brūkšninius kodus, integravimas
 
-## Integruoti duomenų bazę Barkodų saugojimui
-Tam pasinaudosime [ORM lite](http://ormlite.com/sqlite_java_android_orm.shtml).
+Funkcionalumas įgyvendintas, pasitelkus ["ORM Lite"](http://ormlite.com/sqlite_java_android_orm.shtml).
 
-### Susikurti duomenų modelį
+### Duomenų modelio kūrimas
 
-Saugotina informacija
+## Saugotina informacija
 
 Prekė `Item`:
 
-* barcode - Barkodas
-* name - Prekės pavadinimas
-* price - Kaina
-* weight - Svoris
-* image_url - Nuotrauka
+* `barcode` - prekės brūkšninis kodas
+* `name` - prekės pavadinimas
+* `price` - prekės kaina
+* `weight` - prekės svoris (bnors fizikiškai tiksliau būtų vadint mase)
+* `image_url` - prekės nuotrauka
 
 Nuskenuota prekė `ScannedItem`:
 
-* id - nuskenavimo id
-* barcode - prekės barkodas
-* time - Laikas
-* place - Vieta
-* volunteer - Savanoris
-
-[Pakeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/a3d19b796b8731e38383bde4b664b38107565d5e)
+* `id` - unikalus konkretų skenavimą identifikuojantis numeris
+* `barcode` - prekės brūkšninis kodas
+* `time` - skenavimo laikas
+* `place` - skenavimo vieta
+* `volunteer` - savanoris (taip pat gali būti virtuvės šefas ar namų šeimininkė, priklausomai nuo aplinkybių, kuriomis naudojama aplikacija)
 
-### Išsaugoti naujai nuskenuojamas prekes į DB
+### Naujai skenuojamų produktų išsaugojimas duomenų bazėje
 
-Reikės sukurti naują `ScannedItem` objektą ir išsaugoti duomenų bazėje.
+Sukuriamas ir duomenų bazėn patalpinamas naujas `ScannedItem` objektas.
 
-Apie tai, kaip susikurti ORM Lite duomenų bazės `Helper` klasę
-galima paskaityti/pažiūrėti štai čia:
-* [ORM use with Android](http://ormlite.com/javadoc/ormlite-core/doc-files/ormlite_4.html#Use-With-Android)
-* [ORM Android pavyzdžiai](http://ormlite.com/android/examples/)
-* [ORM Android pavyzdys (GitHub'e)](https://github.com/j256/ormlite-examples/blob/master/android/HelloAndroid/src/com/example/helloandroid/DatabaseHelper.java)
+Apie tai, kaip susikurti "ORM Lite" duomenų bazės `Helper` klasę, galima sužinoti iš šių šaltinių:
+* [ORM naudojimas kartu su "Android" operacine sistema](http://ormlite.com/javadoc/ormlite-core/doc-files/ormlite_4.html#Use-With-Android)
+* [ORM taikymo "Android'e" pavyzdžiai](http://ormlite.com/android/examples)
+* [Konkretus taikomasis pavyzdys "GitHub'e"](https://github.com/j256/ormlite-examples/blob/master/android/HelloAndroid/src/com/example/helloandroid/DatabaseHelper.java)
 
-Pasinaudojant `Helper` klase išsaugoti įrašą duomenų bazėje.
+Pasinaudojant `Helper` klase, įrašas išsaugomas duomenų bazėje.
 
-[Pasikeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/e8f589d7b588ebb9ab201e62cf5c1d74cddbd89a)
+### Irašų, išsaugotų duomenų bazėje, rodymas
 
-### Rodyti įrašus išsaugotus duomenų bazėje
-Nuskenuotų prekių sąrašą vis atnaujinti įrašais duomenų bazėje
+## Atvaizduojamas nuskenuotų prekių sąrašas vis atnaujinamas naujais įrašais iš duomenų bazės
 
-* `MainFragment`e `onResume` metode iškviesti `dbHelper.getScannedItemDao().queryForAll();`
-* Sąrašo atvaizdavimui sukurti naują adapterį
-* Sąrašo eilutės vaizdavimui sukurti layout'ą (pradžiai tik su `TextView` barkodo atvaizdavimui)
+* `MainFragment`'e `onResume` metode iškviečiama `dbHelper.getScannedItemDao().queryForAll()` funkcija.
+* Sąrašas bus atvaizduotas, sukūrus naują adapterį.
+* Sąrašo eilutės vaizduojamos sukurtame `layout`'e (kol kas - tik su `TextView`, skirtu ekranan išvesti brūkšninį kodą).
 
-[Pasikeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/)
+## Nuskenuotos prekės informacijos rodymas
 
-### Rodyti informaciją apie nuskenuotą prekę
+* Duomenys apie maisto produktą gaunami ir atitinkamas duomenų modelis sukuriamas, naudojant REST klientą ["Retrofit"](http://square.github.io/retrofit).
+* Prekės informacijos talpinimas duomenų bazėje.
+* Prekės informacijos pavaizdavimas sąraše.
+* Prekės paveiksliukas rodomas, pasitelkus paveikslėlių siuntimo ir kešavimo (talpinimo į podėlį) biblioteką ["Picasso"](http://square.github.io/picasso).
+* Rodoma papildoma prekės informacija.
+* `Nustatymai` mygtukas įtrauktas į meniu.
+* `Skenuoti` mygtukas centruojamas apačioje.
+* Naujausi nuskenuoti įrašai rodomi viršuje.
+* Kai kur naudojama animacija.
 
-* Parsisiųsti prekės informaciją; Susikurti prekės informacijos duomenų modelį. Paskaitykit apie [Retrofit'ą](http://square.github.io/retrofit/). [Pasikeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/9bda4b66796b0bc1d92b2551444c2445f0e18123)
-* Išsaugoti prekės informaciją į DB.
-* Atvaizduoti prekės informaciją sąraše. [Pasikeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/6d6b171d3642c0aeb5e6c9ecc5a5b81b1bfa146b)
-* Parodyti prekės paveiksliuką. Pasiskaitykite apie [Picasso](http://square.github.io/picasso/). [Pasikeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/d5656cab46dd27ef911a1f7239155aa10d3aa727)
-* Rodyti papildomą prekės informaciją. [Pasikeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/6c28fd68decfa446201d0be54e3c77df4f065482)
-* Perkelti `Nustatymai` mygtuką į meniu. [Pasikeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/0f545f4801a240e65b46f6f065fde50d617087fa)
-* Perkelti `Skenuoti` mygtuką į centrą apačioje. [Pasikeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/0252eaf832b892b6a97bc48a9e30c6a7b852277c)
-* Naujausi nuskenuoti įrašai viršuje. [Pasikeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/ef5c2139eb394a6f8056720b57298563c460ce88)
-* Truputis animacijos. [Pasikeitimai](https://github.com/gdgvilnius/MaistoBankas/commit/2cd23dfb75cf4f929e43c20c08b56be77fac4d91)
-
-Dabar atrodo štai taip:
+Ne pagal "Material Design" principus sukurtos vartotojo sąsajos pavyzdys:
 ![2014-03-29 14 37 12](https://cloud.githubusercontent.com/assets/1859636/2558559/b9318ae4-b74f-11e3-8705-30dfbd4ab074.png)
-
diff --git a/app/.gitignore b/app/.gitignore
@@ -1,2 +1,4 @@
 /build
-/app/src/main/java/lt/andro/maistobankas/api/ItemInfoProviders.java
+
+# May be using commercial APIs which are not about to be disclosed
+/app/src/main/java/lt/andro/maistobankas/api/ItemInfoProviders.java
diff --git a/app/build.gradle b/app/build.gradle
@@ -18,7 +18,7 @@ android {
         // is used to configure the manifest 'packageName' entry:
         applicationId "eu.tumenas.valgiounija"
         // The earliest version of the Android SDK that the app supports:
-        minSdkVersion 8     // API 8: Android 2.2 (Froyo).
+        minSdkVersion 8         // API 8: Android 2.2 (Froyo).
         // The highest version of Android with which the app has benn tested:
         targetSdkVersion 21
         versionCode 1

diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
-          package="lt.andro.maistobankas">
+          package="eu.tumenas.maistobankas">
 
     <uses-permission android:name="android.permission.INTERNET" />
 
@@ -11,7 +11,7 @@
         android:label="@string/app_name"
         android:theme="@style/AppTheme">
         <activity
-            android:name="lt.andro.maistobankas.MainActivity"
+            android:name="eu.tumenas.maistobankas.MainActivity"
             android:label="@string/app_name">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />

diff --git a/app/src/main/java/eu/tumenas/maistobankas/BaseActivity.java b/app/src/main/java/eu/tumenas/maistobankas/BaseActivity.java
@@ -1,13 +1,14 @@
-package lt.andro.maistobankas;
+package eu.tumenas.maistobankas;
 
 import android.os.Bundle;
 import android.util.Log;
 
-import lt.andro.maistobankas.db.DatabaseHelper;
-import lt.andro.maistobankas.db.OrmLiteBaseActivity;
+import eu.tumenas.maistobankas.db.DatabaseHelper;
+import eu.tumenas.maistobankas.db.OrmLiteBaseActivity;
 
 /**
  * @author Vilius Kraujutis viliusk@gmail.com
+ * @author M. Tumėnas mantas@tumenas.eu
  * @since 2014-02-08 12:23
  */
 public class BaseActivity extends OrmLiteBaseActivity<DatabaseHelper> {

diff --git a/app/src/main/java/eu/tumenas/maistobankas/BaseFragment.java b/app/src/main/java/eu/tumenas/maistobankas/BaseFragment.java
@@ -1,4 +1,4 @@
-package lt.andro.maistobankas;
+package eu.tumenas.maistobankas;
 
 import android.app.Activity;
 import android.os.Bundle;
@@ -10,6 +10,7 @@
 
 /**
  * @author Vilius Kraujutis viliusk@gmail.com
+ * @author M. Tumėnas mantas@tumenas.eu
  * @since 2014-02-08 13:04
  */
 public class BaseFragment extends Fragment {

diff --git a/app/src/main/java/eu/tumenas/maistobankas/IntentIntegrator.java b/app/src/main/java/eu/tumenas/maistobankas/IntentIntegrator.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package lt.andro.maistobankas;
+package eu.tumenas.maistobankas;
 
 import java.util.Arrays;
 import java.util.Collection;

diff --git a/app/src/main/java/eu/tumenas/maistobankas/IntentResult.java b/app/src/main/java/eu/tumenas/maistobankas/IntentResult.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package lt.andro.maistobankas;
+package eu.tumenas.maistobankas;
 
 /**
  * <p>Encapsulates the result of a barcode scan invoked through {@link IntentIntegrator}.</p>